Google Git
Sign in
apache / struts-archive / a4f00ef127d9e73765bd382a4322ee8465eb4b76 / . / build-legacy / core / xdocs / userGuide / struts-bean.xml
blob: 9dc8acb4c73b2a0505a3571d5bb697d8b5415701 [file] [log] [blame]
<?xml version="1.0"?>
<document url="struts-bean.html" authors="false">
<properties>
<title>The Struts Framework Project - Bean Tags</title>
</properties>
<body>
<taglib>
<tlibversion>1.0</tlibversion>
<jspversion>1.1</jspversion>
<shortname>bean</shortname>
<display-name>Struts Bean Tags</display-name>
<uri>http://jakarta.apache.org/struts/tags-bean</uri>
<info>
<p>This tag library contains tags useful in accessing beans and their
properties, as well as defining new beans (based on these accesses)
that are accessible to the remainder of the page via scripting variables
and page scope attributes. Convenient mechanisms to create new beans
based on the value of request cookies, headers, and parameters are also
provided.</p>
<p>Many of the tags in this tag library will throw a
<code>JspException</code> 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 <code>&lt;%@ page %&gt;</code>
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
<code>org.apache.struts.action.EXCEPTION</code>.</p>
<p>If you are viewing this page from within the Struts Documentation
Application (or online at <a href="http://jakarta.apache.org/struts">
http://jakarta.apache.org/struts</a>), you can learn more about using
these tags in the
<a href="../api/org/apache/struts/taglib/bean/package-summary.html#package_description">
Bean Tags Developer's Guide</a>.</p>
</info>
<tag>
<name>cookie</name>
<summary>
Define a scripting variable based on the value(s) of the specified
request cookie.
</summary>
<tagclass>org.apache.struts.taglib.bean.CookieTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.CookieTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified request cookie (as a single
value or multiple values, depending on the <code>multiple</code> attribute),
and define the result as a page scope attribute of type <code>Cookie</code>
(if <code>multiple</code> is not specified) or <code>Cookie[]</code>
(if <code>multiple</code> is specified).</p>
<p>If no cookie with the specified name can be located, and no default
value is specified, a request time exception will be thrown.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified request cookie.</p>
</info>
</attribute>
<attribute>
<name>multiple</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>If any arbitrary value for this attribute is specified, causes all
matching cookies to be accumulated and stored into a bean of type
<code>Cookie[]</code>. If not specified, the first value for the
specified cookie will be retrieved as a value of type
<code>Cookie</code>.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the request cookie whose value, or values,
is to be retrieved.</p>
</info>
</attribute>
<attribute>
<name>value</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The default cookie value to return if no cookie with the
specified name was included in this request.</p>
</info>
</attribute>
</tag>
<tag>
<name>define</name>
<summary>
Define a scripting variable based on the value(s) of the specified
bean property.
</summary>
<tagclass>org.apache.struts.taglib.bean.DefineTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.DefineTei</teiclass>
<bodycontent>JSP</bodycontent>
<info>
<p>Create a new attribute (in the scope specified by the
<code>toScope</code> property, if any), and a corresponding scripting
variable, both of which are named by the value of the <code>id</code>
attribute. The corresponding value to which this new attribute (and
scripting variable) is set are specified via use of exactly one of the
following approaches (trying to use more than one will result in a
JspException being thrown):</p>
<ul>
<li>Specify a <code>name</code> attribute (plus optional
<code>property</code> and <code>scope</code> attributes) -
The created attribute and scripting variable will be of the type of the
retrieved JavaBean property, unless it is a Java primitive type,
in which case it will be wrapped in the appropriate wrapper class
(i.e. int is wrapped by java.lang.Integer).</li>
<li>Specify a <code>value</code> attribute - The created attribute and
scripting variable will be of type <code>java.lang.String</code>,
set to the value of this attribute.</li>
<li>Specify nested body content - The created attribute and scripting
variable will be of type <code>java.lang.String</code>, set to
the value of the nested body content.</li>
</ul>
<p>If a problem occurs while retrieving the specified bean property, a
request time exception will be thrown.</p>
<p>The <code>&lt;bean:define&gt;</code> tag differs from
<code>&lt;jsp:useBean&gt;</code> in several ways, including:</p>
<ul>
<li>Unconditionally creates (or replaces) a bean under the
specified identifier.</li>
<li>Can create a bean with the value returned by a property getter
of a different bean (including properties referenced with a
nested and/or indexed property name).</li>
<li>Can create a bean whose contents is a literal string (or the result
of a runtime expression) specified by the <code>value</code>
attribute.</li>
<li>Does not support nested content (such as
<code>&lt;jsp:setProperty&gt;</code> tags) that are only executed
if a bean was actually created.</li>
</ul>
<p><strong>USAGE NOTE</strong> - There is a restriction in the JSP 1.1
Specification that disallows using the same value for an <code>id</code>
attribute more than once in a single JSP page. Therefore, you will not
be able to use <code>&lt;bean:define&gt;</code> for the same bean
name more than once in a single page.</p>
<p><strong>USAGE NOTE</strong> - If you use another tag to create the
body content (e.g. bean:write), that tag must return a non-empty String.
An empty String equates to an empty body or a null String, and a new
scripting variable cannot be defined as null. Your bean must return a
non-empty String, or the define tag must be wrapped within a logic tag
to test for an empty or null value.</p>
<p><strong>USAGE NOTE</strong> - You cannot use bean:define to <strong>instantiate</strong>
a DynaActionForm (type="org.apache.struts.action.DynaActionForm") with
the properties specified in the struts-config. The mechanics of creating
the dyna-properties is complex and cannot be handled by a no-argument
constructor. If you need to create an ActionForm this way, you must use
a conventional ActionForm.
</p>
<p>See the Bean Developer's Guide section on
<a href="../api/org/apache/struts/taglib/bean/package-summary.html#doc.Creation">
bean creation</a> for more information about these differences, as well
as alternative approaches to introducing beans into a JSP page.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified property.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the attribute name of the bean whose property is accessed
to define a new page scope attribute (if <code>property</code> is also
specified) or the attribute name of the bean that is duplicated with
the new reference created by this tag (if <code>property</code> is not
also specified). This attribute is required unless you specify
a <code>value</code> attribute or nested body content.</p>
</info>
</attribute>
<attribute>
<name>property</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the property to be accessed on the bean
specified by <code>name</code>. This value may be a simple, indexed,
or nested property reference expression. If not specified, the bean
identified by <code>name</code> is given a new reference identified by
<code>id</code>.</p>
</info>
</attribute>
<attribute>
<name>scope</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the variable scope searched to retrieve the bean specified
by <code>name</code>. If not specified, the default rules applied by
<code>PageContext.findAttribute()</code> are applied.</p>
</info>
</attribute>
<attribute>
<name>toScope</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the variable scope into which the newly defined bean will
be created. If not specified, the bean will be created in
<code>page</code> scope.</p>
</info>
</attribute>
<attribute>
<name>type</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the fully qualified class name of the value to be exposed
as the <code>id</code> attribute.</p>
</info>
<default>
<code>java.lang.String</code> (if you specify a <code>value</code>
attribute) or <code>java.lang.Object</code> otherwise.
</default>
</attribute>
<attribute>
<name>value</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The <code>java.lang.String</code> value to which the exposed bean
should be set. This attribute is required unless you specify the
<code>name</code> attribute or nested body content.</p>
</info>
</attribute>
</tag>
<tag>
<name>header</name>
<summary>
Define a scripting variable based on the value(s) of the specified
request header.
</summary>
<tagclass>org.apache.struts.taglib.bean.HeaderTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.HeaderTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified request header (as a single
value or multiple values, depending on the <code>multiple</code> attribute),
and define the result as a page scope attribute of type <code>String</code>
(if <code>multiple</code> is not specified) or <code>String[]</code>
(if <code>multiple</code> is specified).</p>
<p>If no header with the specified name can be located, and no default
value is specified, a request time exception will be thrown.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified request header.</p>
</info>
</attribute>
<attribute>
<name>multiple</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>If any arbitrary value for this attribute is specified, causes a call
to <code>HttpServletRequest.getHeaders()</code> and a definition of the
result as a bean of type <code>String[]</code>. Otherwise,
<code>HttpServletRequest.getHeader()</code> will be called, and a
definition of the result as a bean of type <code>String</code>
will be performed.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the request header whose value, or values,
is to be retrieved.</p>
</info>
</attribute>
<attribute>
<name>value</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The default header value to return if no header with the
specified name was included in this request.</p>
</info>
</attribute>
</tag>
<tag>
<name>include</name>
<summary>
Load the response from a dynamic application request and make it available
as a bean.
</summary>
<tagclass>org.apache.struts.taglib.bean.IncludeTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.IncludeTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Perform an internal dispatch to the specified application component
(or external URL)
and make the response data from that request available as a bean of
type <code>String</code>. This tag has a function similar to that of
the standard <code>&lt;jsp:include&gt;</code> tag, except that the
response data is stored in a page scope attribute instead of being
written to the output stream. If the current request is part of a
session, the generated request for the include will also include the
session identifier (and thus be part of the same session).</p>
<p>The URL used to access the specified application component is
calculated based on which of the following attributes you specify
(you must specify exactly one of them):</p>
<ul>
<li><em>forward</em> - Use the value of this attribute as the name
of a global <code>ActionForward</code> to be looked up, and
use the application-relative or context-relative URI found there.</li>
<li><em>href</em> - Use the value of this attribute unchanged (since
this might link to a resource external to the application, the
session identifier is <strong>not</strong> included.</li>
<li><em>page</em> - Use the value of this attribute as an
application-relative URI to the desired resource.</li>
</ul>
</info>
<p><strong>WARNING</strong> - Accessing resources protected by security
constraints, or resources under the <code>/WEB-INF</code> subdirectory,
with this tag is not supported. Consider using the
<code>&lt;jsp:include ... flush="false"&gt;</code> tag on a JSP 1.2
or later container, or the
<code>&lt;c:import&gt;</code> tag from the JSP Standard Tag Library
to accomplish this.</p>
<attribute>
<name>anchor</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Optional anchor tag ("#xxx") to be added to the generated
hyperlink. Specify this value <strong>without</strong> any
"#" character.</p>
</info>
</attribute>
<attribute>
<name>forward</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Logical name of a global <code>ActionForward</code> that contains
the actual content-relative URI of the resource to be included.</p>
</info>
</attribute>
<attribute>
<name>href</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Absolute URL (including the appropriate protocol prefix such as
"http:") of the resource to be included. Because this URL could be
external to the current web application, the session identifier will
<strong>not</strong> be included in the request.</p>
</info>
</attribute>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified web application resource.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Application-relative name (starting with a '/') of the web application
resource to be dispatched, and whose response data is to be made
available as a bean.</p>
</info>
<deprecated>
Use the "page" attribute instead.
</deprecated>
</attribute>
<attribute>
<name>page</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Application-relative URI (starting with a '/') of the web application
resource to be included.</p>
</info>
</attribute>
<attribute>
<name>transaction</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Set to <code>true</code> if you want the current
transaction control token included in the generated
URL for this include.</p>
</info>
</attribute>
</tag>
<tag>
<name>message</name>
<summary>
Render an internationalized message string to the response.
</summary>
<tagclass>org.apache.struts.taglib.bean.MessageTag</tagclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieves an internationalized message for the specified locale,
using the specified message key, and write it to the output stream.
Up to five parametric replacements (such as "{0}") may be specified.</p>
<p>The message key may be specified directly, using the <code>key</code>
attribute, or indirectly, using the <code>name</code> and
<code>property</code> attributes to obtain it from a bean.</p>
<p>
<strong>JSTL</strong>: The equivalent JSTL tag is &lt;fmt:message&gt;. For example,
<br/>
<code>
&lt;fmt:message key="my.msg.key"&gt;
&lt;fmt:param value="replacement text"/&gt;
&lt;/fmt:message&gt;
</code>
</p>
</info>
<attribute>
<name>arg0</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>First parametric replacement value, if any.</p>
</info>
</attribute>
<attribute>
<name>arg1</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Second parametric replacement value, if any.</p>
</info>
</attribute>
<attribute>
<name>arg2</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Third parametric replacement value, if any.</p>
</info>
</attribute>
<attribute>
<name>arg3</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Fourth parametric replacement value, if any.</p>
</info>
</attribute>
<attribute>
<name>arg4</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Fifth parametric replacement value, if any.</p>
</info>
</attribute>
<attribute>
<name>bundle</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The name of the application scope bean under which the
<code>MessageResources</code> object containing our messages
is stored.</p>
</info>
<default>Globals.MESSAGES_KEY</default>
</attribute>
<attribute>
<name>key</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The message key of the requested message, which must have
a corresponding value in the message resources. If not specified,
the key is obtained from the <code>name</code> and
<code>property</code> attributes.</p>
</info>
</attribute>
<attribute>
<name>locale</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The name of the session scope bean under which our currently
selected <code>Locale</code> object is stored.</p>
</info>
<default>Globals.LOCALE_KEY</default>
</attribute>
<attribute>
<name>name</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the attribute name of the bean whose property is accessed
to retrieve the value specified by <code>property</code> (if
specified). If <code>property</code> is not specified, the value of
this bean itself will be used as the message resource key.</p>
</info>
</attribute>
<attribute>
<name>property</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the property to be accessed on the bean
specified by <code>name</code>. This value may be a simple, indexed,
or nested property reference expression. If not specified, the value
of the bean identified by <code>name</code> will itself be used as the
message resource key.</p>
</info>
</attribute>
<attribute>
<name>scope</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the variable scope searched to retrieve the bean specified
by <code>name</code>. If not specified, the default rules applied by
<code>PageContext.findAttribute()</code> are applied.</p>
</info>
</attribute>
</tag>
<tag>
<name>page</name>
<summary>
Expose a specified item from the page context as a bean.
</summary>
<tagclass>org.apache.struts.taglib.bean.PageTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.PageTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified item from the page context
for this page, and define it as a scripting variable, and a page scope
attribute accessible to the remainder of the current page.</p>
<p>If a problem occurs while retrieving the specified configuration
object, a request time exception will be thrown.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated
page scope attribute) that will be made available with the value of
the specified page context property.</p>
</info>
</attribute>
<attribute>
<name>property</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Name of the property from our page context to be retrieved and
exposed. Must be one of <code>application</code>, <code>config</code>,
<code>request</code>, <code>response</code>, or <code>session</code>.
</p>
</info>
</attribute>
</tag>
<tag>
<name>parameter</name>
<summary>
Define a scripting variable based on the value(s) of the specified
request parameter.
</summary>
<tagclass>org.apache.struts.taglib.bean.ParameterTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.ParameterTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified request parameter (as a single
value or multiple values, depending on the <code>multiple</code> attribute),
and define the result as a page scope attribute of type <code>String</code>
(if <code>multiple</code> is not specified) or <code>String[]</code>
(if <code>multiple</code> is specified).</p>
<p>If no request parameter with the specified name can be located, and
no default value is specified, a request time exception will be thrown.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified request parameter.</p>
</info>
</attribute>
<attribute>
<name>multiple</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>If any arbitrary value for this attribute is specified, causes a call
to <code>ServletRequest.getParameterValues()</code> and a definition of
the result as a bean of type <code>String[]</code>. Otherwise,
<code>ServletRequest.getParameter()</code> will be called, and a
definition of the result as a bean of type <code>String</code>
will be performed.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the request parameter whose value, or values,
is to be retrieved.</p>
</info>
</attribute>
<attribute>
<name>value</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The default parameter value to return if no parameter with the
specified name was included in this request.</p>
</info>
</attribute>
</tag>
<tag>
<name>resource</name>
<summary>
Load a web application resource and make it available as a bean.
</summary>
<tagclass>org.apache.struts.taglib.bean.ResourceTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.ResourceTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified web application resource, and make
it available as either a <code>InputStream</code> or a <code>String</code>,
depending on the value of the <code>input</code> attribute.</p>
<p>If a problem occurs while retrieving the specified resource, a
request time exception will be thrown.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified web application resource.</p>
</info>
</attribute>
<attribute>
<name>input</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>If any arbitrary value for this attribute is specified, the resource
will be made available as an <code>InputStream</code>. If this
attribute is not specified, the resource will be made available
as a <code>String</code>.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Application-relative name (starting with a '/') of the web application
resource to be loaded and made available.</p>
</info>
</attribute>
</tag>
<tag>
<name>size</name>
<summary>
Define a bean containing the number of elements in a Collection or Map.
</summary>
<tagclass>org.apache.struts.taglib.bean.SizeTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.SizeTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Given a reference to an array, Collection or Map, creates a new bean, of
type <code>java.lang.Integer</code>, whose value is the number of elements
in that collection. You can specify the collection to be counted in any
one of the following ways:</p>
<ul>
<li>As a runtime expression specified as the value of the
<code>collection</code> attribute.</li>
<li>As a JSP bean specified by the <code>name</code> attribute.</li>
<li>As the property, specified by the <code>property</code> attribute,
of the JSP bean specified by the <code>name</code> attribute.</li>
</ul>
</info>
<attribute>
<name>collection</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>A runtime expression that evaluates to an array, a Collection, or
a Map.</p>
</info>
</attribute>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>The name of a page scope JSP bean, of type
<code>java.lang.Integer</code>, that will be created to contain the
size of the underlying collection being counted.</p>
</info>
</attribute>
<attribute>
<name>name</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The name of the JSP bean (optionally constrained to the scope
specified by the <code>scope</code> attribute) that contains the
collection to be counted (if <code>property</code> is not specified),
or whose property getter is called to return the collection to be
counted (if <code>property</code> is specified.</p>
</info>
</attribute>
<attribute>
<name>property</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The name of the property, of the bean specified by the
<code>name</code> attribute, whose getter method will return the
collection to be counted.</p>
</info>
</attribute>
<attribute>
<name>scope</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The bean scope within which to search for the JSP bean specified
by the <code>name</code> attribute. If not specified, the available
scopes are searched in ascending sequence.</p>
</info>
</attribute>
</tag>
<tag>
<name>struts</name>
<summary>
Expose a named Struts internal configuration object as a bean.
</summary>
<tagclass>org.apache.struts.taglib.bean.StrutsTag</tagclass>
<teiclass>org.apache.struts.taglib.bean.StrutsTei</teiclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified Struts internal configuration
object, and define it as a scripting variable and as a page scope
attribute accessible to the remainder of the current page. You must
specify exactly one of the <code>formBean</code>, <code>forward</code>,
and <code>mapping</code> attributes to select the configuration object
to be exposed.</p>
<p>If a problem occurs while retrieving the specified configuration
object, a request time exception will be thrown.</p>
</info>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<info>
<p>Specifies the name of the scripting variable (and associated
page scope attribute) that will be made available with the value of
the specified Struts internal configuration object.</p>
</info>
</attribute>
<attribute>
<name>formBean</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the Struts <code>ActionFormBean</code>
definition object to be exposed.</p>
</info>
</attribute>
<attribute>
<name>forward</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the global Struts <code>ActionForward</code>
definition object to be exposed.</p>
</info>
</attribute>
<attribute>
<name>mapping</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the matching path of the Struts <code>ActionMapping</code>
definition object to be exposed.</p>
</info>
</attribute>
</tag>
<tag>
<name>write</name>
<summary>
Render the value of the specified bean property to the current
JspWriter.
</summary>
<tagclass>org.apache.struts.taglib.bean.WriteTag</tagclass>
<bodycontent>empty</bodycontent>
<info>
<p>Retrieve the value of the specified bean property, and render it to the
current JspWriter as a String by the ways:</p>
<ul>
<li>If <code>format</code> attribute exists then value will be formatted on base of format
string from <code>format</code> attribute and default system locale.</li>
<li>If in resources exists format string for value data type (view <code>format</code>
attribute description) then value will be formatted on base of format string
from resources. Resources bundle and target locale can be specified with
<code>bundle</code> and <code>locale</code> attributes. If nothing specified then
default resource bundle and current user locale will be used.</li>
<li>If there is a PropertyEditor configured for the property value's class, the
<code>getAsText()</code> method will be called.</li>
<li>Otherwise, the usual <code>toString()</code> conversions will be applied.</li>
</ul>
<p>If a problem occurs while retrieving the specified bean property, a
request time exception will be thrown.</p>
</info>
<attribute>
<name>bundle</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The name of the application scope bean under which the
<code>MessageResources</code> object containing our messages
is stored.</p>
</info>
<default>Globals.MESSAGES_KEY</default>
</attribute>
<attribute>
<name>filter</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>If this attribute is set to <code>true</code>, the rendered property
value will be filtered for characters that are sensitive in HTML, and any
such characters will be replaced by their entity equivalents.</p>
</info>
<default>true</default>
</attribute>
<attribute>
<name>format</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the format string to use to convert bean or property value
to the <code>String</code>. If nothing specified, then default format
string for value data type will be searched in message resources by
according key.</p>
<!-- move to developers guide
<table>
<tr>
<td>Key to search format string</td>
<td>Data types</td>
</tr>
<tr>
<td>org.apache.struts.taglib.bean.format.int</td>
<td>java.lang.Byte, java.lang.Short, java.lang.Integer, java.lang.Long,
java.math.BigInteger</td>
</tr>
<tr>
<td>org.apache.struts.taglib.bean.format.float</td>
<td>java.lang.Float, java.lang.Double, java.math.BigDecimal</td>
</tr>
<tr>
<td>org.apache.struts.taglib.bean.format.sql.timestamp</td>
<td>java.sql.Timestamp</td>
</tr>
<tr>
<td>org.apache.struts.taglib.bean.format.sql.date</td>
<td>java.sql.Date</td>
</tr>
<tr>
<td>org.apache.struts.taglib.bean.format.sql.time</td>
<td>java.sql.Time</td>
</tr>
<tr>
<td>org.apache.struts.taglib.bean.format.date</td>
<td>java.util.Date</td>
</tr>
</table>
<p>Default format strings in resources can be written as - <br />
<pre>
org.apache.struts.taglib.bean.format.int=######
org.apache.struts.taglib.bean.format.float=######,####
org.apache.struts.taglib.bean.format.sql.timestamp=hh 'o''clock' a, zzzz
org.apache.struts.taglib.bean.format.sql.date=EEE, MMM d, ''yy
org.apache.struts.taglib.bean.format.sql.time=h:mm a
org.apache.struts.taglib.bean.format.date=hh 'o''clock' a, zzzz
</pre>
<br />values for resource file entries are standart Java format strings for
date, time and number values.</p>
-->
</info>
</attribute>
<attribute>
<name>formatKey</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the key to search format string in application resources.</p>
</info>
</attribute>
<attribute>
<name>ignore</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>If this attribute is set to <code>true</code>, and the bean specified
by the <code>name</code> and <code>scope</code> attributes does not
exist, simply return without writing anything. If this attribute is
set to <code>false</code>, a runtime exception to be thrown,
consistent with the other tags in this tag library.</p>
</info>
<default>false</default>
</attribute>
<attribute>
<name>locale</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>The name of the session scope bean under which our currently
selected <code>Locale</code> object is stored.</p>
</info>
<default>Globals.LOCALE_KEY</default>
</attribute>
<attribute>
<name>name</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the attribute name of the bean whose property is accessed
to retrieve the value specified by <code>property</code> (if
specified). If <code>property</code> is not specified, the value of
this bean itself will be rendered.</p>
</info>
</attribute>
<attribute>
<name>property</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the name of the property to be accessed on the bean
specified by <code>name</code>. This value may be a simple, indexed,
or nested property reference expression. If not specified, the bean
identified by <code>name</code> will itself be rendered. If the
specified property returns null, no output will be rendered.</p>
</info>
</attribute>
<attribute>
<name>scope</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<info>
<p>Specifies the variable scope searched to retrieve the bean specified
by <code>name</code>. If not specified, the default rules applied by
<code>PageContext.findAttribute()</code> are applied.</p>
</info>
</attribute>
</tag>
</taglib>
</body>
</document>