struts-bean.tld

Apache struts-1.3.10 a stable version

            <description>
                <![CDATA[
      <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>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>scope</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <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>
      ]]>
            </description>
        </attribute>
    </tag>
    <tag>
        <name>struts</name>
        <tag-class>org.apache.struts.taglib.bean.StrutsTag</tag-class>
        <tei-class>org.apache.struts.taglib.bean.StrutsTei</tei-class>
        <body-content>empty</body-content>
        <description>
            <![CDATA[
            <p><strong>
    Expose a named Struts internal configuration object as a bean.
    </strong></p>
          
    <p>Retrieve the value of the specified Struts internal configuration
    object, and define it as a scripting variable and as a page scope
    attribute accessible to the remainder of the current page.  You must
    specify exactly one of the <code>formBean</code>, <code>forward</code>,
    and <code>mapping</code> attributes to select the configuration object
    to be exposed.</p>

    <p>If a problem occurs while retrieving the specified configuration
    object, a request time exception will be thrown.</p>
    ]]>
        </description>
        <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 Struts internal configuration object.</p>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>formBean</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <p>Specifies the name of the Struts <code>ActionFormBean</code>
      definition object to be exposed.</p>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>forward</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <p>Specifies the name of the global Struts <code>ActionForward</code>
      definition object to be exposed.</p>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>mapping</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <p>Specifies the matching path of the Struts <code>ActionMapping</code>
      definition object to be exposed.</p>
      ]]>
            </description>
        </attribute>
    </tag>
    <tag>
        <name>write</name>
        <tag-class>org.apache.struts.taglib.bean.WriteTag</tag-class>
        <body-content>empty</body-content>
        <description>
            <![CDATA[
            <p><strong>
    Render the value of the specified bean property to the current
    JspWriter.
    </strong></p>
          
    <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>When a format string is provided, numeric values are formatted using the
    <code>java.text.DecimalFormat</code> class; if the format string came from
    a resource, the <code>applyLocalisedPattern()</code> method is used, and
    <code>applyPattern()</code> is used otherwise. Dates are formatted using
    the <code>SimpleDateFormat</code> class. For details of the specific format
    patterns, please see the Javadocs for those classes.</p>
    <p>If a problem occurs while retrieving the specified bean property, a
    request time exception will be thrown.</p>
    ]]>
        </description>
        <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>filter</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <type>boolean</type>
            <description>
                <![CDATA[
      <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>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>format</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <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>
-->
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>formatKey</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <p>Specifies the key to search format string in application resources.</p>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>ignore</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <type>boolean</type>
            <description>
                <![CDATA[
      <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>
      ]]>
            </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>true</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 rendered.</p>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>property</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <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>
      ]]>
            </description>
        </attribute>
        <attribute>
            <name>scope</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <description>
                <![CDATA[
      <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>
      ]]>
            </description>
        </attribute>
    </tag>
</taglib>