displaytag.tld

分页标签

    </attribute>
    <attribute>
      <name>format</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        A MessageFormat patter that will be used to decorate objects in the column. Can be used as a "shortcut" for
        simple column decorations. @since 1.1
      </description>
    </attribute>
    <attribute>
      <name>escapeXml</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>boolean</type>
      <description>
        Set it to true to escape special characters in html and xml output. Defaults to 'false'. @since 1.1
      </description>
    </attribute>
    <attribute>
      <name>media</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        Use this attribute to keep a column from being output during an export. The column will only render for the
        named media type(s) - it won't be added to the table if the current request media is not supported. Can be any
        space separated combination of 'html', 'csv', 'xml', 'all', or 'excel'. Defaults to 'all'. See the export page
        in the example webapp for more details.
      </description>
    </attribute>
    <attribute>
      <name>href</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        <![CDATA[
        The base URL used to construct the dynamic link. If this attribute is provided, then the data that is shown for
        this column is wrapped inside a <a href=""> tag with the url provided through this attribute. Typically you
        would use this attribute along with one of the struts-like param attributes (param*) to create a dynamic link so
        that each row creates a different URL based on the data that is being viewed. An empty href value will generate
        a link to the current page, preserving parameters just like for paging links.]]>
      </description>
    </attribute>
    <attribute>
      <name>url</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        The base URL used to construct the dynamic link. This attribute has the same functionality as the href
        attribute, but it pre-pends the contextPath.
      </description>
    </attribute>
    <attribute>
      <name>paramId</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        The name of the request parameter that will be dynamically added to the generated href URL. The corresponding
        value is defined by the paramProperty and (optional) paramName attributes, optionally scoped by the paramScope
        attribute.
      </description>
    </attribute>
    <attribute>
      <name>paramName</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        The name of a JSP bean that is a String containing the value for the request parameter named by paramId (if
        paramProperty is not specified), or a JSP bean whose property getter is called to return a String (if
        paramProperty is specified). The JSP bean is constrained to the bean scope specified by the paramScope property,
        if it is specified. If paramName is omitted, then it is assumed that the current object being iterated on is the
        target bean.
      </description>
    </attribute>
    <attribute>
      <name>paramProperty</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        The name of a property of the current object being iterated on, whose return value will be used as the value of
        the parameter (named by the paramId attribute) that will be dynamically added to this href URL. If paramName is
        also specified the property will not be fetched from the object being iterated on, but from the bean specified
        by paramName. The support of paramProperty in conjunction with paramName will be probably removed in future: use
        paramProperty only if you need a property in the iterated object, elsewhere use only paramName (you can select a
        property using an expression name.property).
      </description>
    </attribute>
    <attribute>
      <name>paramScope</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        @deprecated - use Expressions in paramName. The scope within which to search for the bean specified by the
        paramName attribute. If not specified, all scopes are searched. If paramName is not provided, then the current
        object being iterated on is assumed to be the target bean.
      </description>
    </attribute>
    <attribute>
      <name>maxLength</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>int</type>
      <description>
        If this attribute is provided, then the column's displayed is limited to this number of characters. An elipse
        (...) is appended to the end if this column is linked, and the user can mouseover the elipse to get the full
        text. Be careful on using this attribute for String which can contain html tags or entities, or together with
        the autolink attribute turned on: displaytag will do its best trying to avoid leaving unclosed tags or broken
        entities in the output, but a complex or bad input could lead to unattended results.
      </description>
    </attribute>
    <attribute>
      <name>maxWords</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>int</type>
      <description>
        If this attribute is provided, then the column's displayed is limited to this number of words. An elipse (...)
        is appended to the end if this column is linked, and the user can mouseover the elipse to get the full text. Be
        careful on using this attribute for String which can contain html tags or entities, or together with the
        autolink attribute turned on: displaytag will do its best trying to avoid leaving unclosed tags or broken
        entities in the output, but a complex or bad input could lead to unattended results.
      </description>
    </attribute>
    <attribute>
      <name>class</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        html pass through attribute; use this instead of directly coding presentational atttributes.
      </description>
    </attribute>
    <attribute>
      <name>headerClass</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>"class" html attribute added only for header cells.</description>
    </attribute>
    <attribute>
      <name>style</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>group</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>int</type>
      <description>
        The grouping level (starting at 1 and incrementing) of this column (indicates if successive contain the same
        values, then they should not be displayed). The level indicates that if a lower level no longer matches, then
        the matching for this higher level should start over as well. If this attribute is not included, then no
        grouping is performed.
      </description>
    </attribute>
    <attribute>
      <name>decorator</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        Whitespace separated list of column decorators to apply to the current column. A table decorator name can be the
        name of an object in page, request, session or application scope or a fully qualified class name of a class
        implementing the org.displaytag.decorator.DisplaytagColumnDecorator interface. If a decorator is specified for
        the entire table, then this decorator will decorate that decorator.
      </description>
    </attribute>
    <attribute>
      <name>sortName</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        Used with sort="external", the name that should be given to the server to sort this column. IE if
        sortName="buzz", then the href for this column to sort will have a parameter d-(encodedId)-s=buzz. If sortName
        is ommitted the value for the sort param will default to the column number.
      </description>
    </attribute>
    <attribute>
      <name>headerScope</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>"scope" html attribute added only for header cells.</description>
    </attribute>
    <attribute>
      <name>scope</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>"scope" html attribute.</description>
    </attribute>
    <attribute>
      <name>value</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.Object</type>
      <description>
        Static value to be used for the column. It has the same meaning of setting a value in the tag body, but values
        set using this attribute will not be coerced to Strings. You may need to use the value attribute instead of a
        scriptlet in the tag body if you need to calculate totals on numeric values.
      </description>
    </attribute>
  </tag>
  <tag>
    <name>setProperty</name>
    <tag-class>org.displaytag.tags.SetPropertyTag</tag-class>
    <body-content>JSP</body-content>
    <display-name>setProperty</display-name>
    <description>
      Sets the indicated property on the enclosing Table tag. MUST be nested within a Table tag. As an alternative, you
      may create a property file that holds sitewide defaults; see the configuration documentation or the
      DisplayPropertiesLoaderServlet javadoc for information.
    </description>
    <attribute>
      <name>name</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>The name of the property to set on the enclosing Table tag.</description>
    </attribute>
    <attribute>
      <name>value</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        The value to which the property is set. You can also set the property value in the tag body.
      </description>
    </attribute>
    <example>
      <![CDATA[
<display:setProperty name="paging.banner.placement" value="bottom" />
or
<display:setProperty name="paging.banner.placement">bottom</display:setProperty>
]]>
    </example>
  </tag>
  <tag>
    <name>footer</name>
    <tag-class>org.displaytag.tags.TableFooterTag</tag-class>
    <body-content>JSP</body-content>
    <display-name>footer</display-name>
    <description>
      Tag wich should be nested into a table tag to provide a custom table footer. The body of the tag is into the tfoot
      section of the table. The totals variable, if designated, will be in pageContext in this tag.
    </description>
    <attribute>
      <name>media</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        Use this attribute to keep a footer from being output during an export. The caption will only render for the
        named media type(s) - it won't be added to the table if the current request media is not supported. Can be any
        space separated combination of 'html', 'csv', 'xml', 'all', or 'excel'. Defaults to 'all'. See the export page
        in the example webapp for more details.
      </description>
    </attribute>
    <example>
      <![CDATA[
<display:table name="someList" varTotals="totals">
  <display:column property="itemName"/>
  <display:column property="price" total="true"/>
  <display:footer>
    <tr>
      <td>Total Bill:</td>
      <td><c:out value="${totals.column2}" /></td>
    <tr>
  </display:footer>
</display:table>
]]>
    </example>
  </tag>
  <tag>
    <name>caption</name>
    <tag-class>org.displaytag.tags.CaptionTag</tag-class>
    <body-content>JSP</body-content>
    <display-name>caption</display-name>
    <description>
      Simple tag which mimics the html caption tag. Use it inside a table tag to display a caption.
    </description>
    <attribute>
      <name>style</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>class</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>id</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>title</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>lang</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>dir</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>html pass through attribute.</description>
    </attribute>
    <attribute>
      <name>media</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <type>java.lang.String</type>
      <description>
        Use this attribute to keep a caption from being output during an export. The caption will only render for the
        named media type(s) - it won't be added to the table if the current request media is not supported. Can be any
        space separated combination of 'html', 'csv', 'xml', 'all', or 'excel'. Defaults to 'all'. See the export page
        in the example webapp for more details.
      </description>
    </attribute>
    <example>
      <![CDATA[
<display:table name="someList">
  <display:column property="mail"/>
  <display:column property="total"/>
  <display:caption>This is the table caption</display:caption>
</display:table>
]]>
    </example>
  </tag>
</taglib>