struts-bean-el.tld

Apache struts-1.3.10 a stable version

<?xml version="1.0" encoding="UTF-8"?>
<!--
    $Id: struts-bean-el.tld 481833 2006-12-03 17:32:52Z niallp $

    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at
   
         http://www.apache.org/licenses/LICENSE-2.0
   
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-->
<!DOCTYPE taglib PUBLIC
        "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
        "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<taglib>
    <tlib-version>1.3</tlib-version>
    <jsp-version>1.2</jsp-version>
    <short-name>bean</short-name>
    <uri>http://struts.apache.org/tags-bean-el</uri>
    <description>
        <![CDATA[
   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.Many of the tags in this tag library will throw a
  JspException at runtime when they are utilized incorrectly
  (such as when you specify an invalid combination of tag attributes).  JSP
  allows you to declare an "error page" in the <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
  org.apache.struts.action.EXCEPTION.If you are viewing this page from within 
  the Struts Documentation Application (or online at 
  http://struts.apache.org), you can learn more about using
  these tags in the  Bean Tags Developer's Guide.
  ]]>
    </description>
    <tag>
        <name>include</name>
        <tag-class>org.apache.strutsel.taglib.bean.ELIncludeTag</tag-class>
        <tei-class>org.apache.struts.taglib.bean.IncludeTei</tei-class>
        <body-content>empty</body-content>
        <description>
            <![CDATA[
      <p><strong>Load the response from a dynamic application request 
      and make it available as a bean.</strong></p>
      
      <p>Perform an internal dispatch to the specified application component (or
      external URL) and make the response data from that request available as a
      scoped variable of type <code>String</code>. This tag has a function
      similar to that of the standard <code>&lt;jsp:include&gt;</code> tag,
      except that the response data is stored in a page scope attribute instead
      of being written to the output stream. If the current request is part of a
      session, the generated request for the include will also include the
      session identifier (and thus be part of the same session).</p> <p>The URL
      used to access the specified application component is calculated based on
      which of the following attributes you specify (you must specify exactly
      one of them):</p>
    
      <ul>
        <li>
          <em>forward</em> - Use the value of this attribute as the name
          of a global <code>ActionForward</code> to be looked up, and
          use the module-relative or context-relative URI found there.</li>
        <li>
          <em>href</em> - Use the value of this attribute unchanged (since
          this might link to a resource external to the application, the
          session identifier is <strong>not</strong> included.</li>
        <li>
          <em>page</em> - Use the value of this attribute as an
          module-relative URI to the desired resource.</li>
      </ul>
      ]]>
        </description>
        <attribute>
            <name>anchor</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>Optional anchor tag ("#xxx") to be added to the generated
            hyperlink.  Specify this value <strong>without</strong> any
            "#" character.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>forward</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>Logical name of a global <code>ActionForward</code> that contains
            the actual content-relative URI of the resource to be included.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>href</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <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>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>id</name>
            <required>true</required>
            <rtexprvalue>false</rtexprvalue>
            <description>
                <![CDATA[
         <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>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>page</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <p>Module-relative URI (starting with a '/') of the web application
         resource to be included.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>transaction</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <p>Set to <code>true</code> if you want the current
         transaction control token included in the generated
         URL for this include.</p>
         ]]>
            </description>
        </attribute>
    </tag>
    <tag>
        <name>message</name>
        <tag-class>org.apache.strutsel.taglib.bean.ELMessageTag</tag-class>
        <body-content>empty</body-content>
        <description>
            <![CDATA[
      <p><strong>Render an internationalized message string to the response.
      </strong></p>
      <p>Retrieves an internationalized message for the specified locale,
      using the specified message key, and write it to the output stream.
      Up to five parametric replacements (such as "{0}") may be specified.</p>
      <p>The message key may be specified directly, using the <code>key</code>
      attribute, or indirectly, using the <code>name</code> and
      <code>property</code> attributes to obtain it from a bean.</p>
      <p><strong>JSTL</strong>:  The equivalent JSTL tag is 
      <code>&lt;fmt:message&gt;</code>.  For example,
      <br/>
      <code>
    	&lt;fmt:message key="my.msg.key">
    	  &lt;fmt:param value="replacement text"/>
    	&lt;/fmt:message>
      </code>
      </p>
      ]]>
        </description>
        <attribute>
            <name>arg0</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>First parametric replacement value, if any.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>arg1</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>Second parametric replacement value, if any.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>arg2</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>Third parametric replacement value, if any.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>arg3</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>Fourth parametric replacement value, if any.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>arg4</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
            <p>Fifth parametric replacement value, if any.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>bundle</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <p>The name of the application scope bean under which the
         <code>MessageResources</code> object containing our messages
         is stored.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>key</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <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>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>locale</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <p>The name of the session scope bean under which our currently
         selected <code>Locale</code> object is stored.</p>
         ]]>
            </description>
        </attribute>
        <attribute>
            <name>name</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
         <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>
         ]]>
            </description>