|Published (Last):||20 October 2007|
|PDF File Size:||12.41 Mb|
|ePub File Size:||6.29 Mb|
|Price:||Free* [*Free Regsitration Required]|
The display tag library is an open source suite of custom tags that provide high level web presentation patterns which will work in a MVC model, and provide a significant amount of functionality while still being simple and straight-forward to use. The primary tag in the library is the Table tag.
Simple tag which mimics the html caption tag. Use it inside a table tag to display a caption. Displays a property of a row object inside a table.
MUST be nested inside of a Table tag. The value displayed will be the results of a decorator if any ; else the property named by the 'property' attribute; or if the 'property' attribute is null, then the results of evaluating the JSP body of the tag.
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. 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.
Displays a list in an html table, formatting each item in the list according to the Column tags nested inside of this tag. Use the list attribute to indicate the Collection of data, in some scope, that the tag should operate on. The contents of the list can be sorted, and the list can be broken into individual pages for display. If you use this tag in Struts, or in some other framework where the page is included via a jsp:include, you should use the requestURI attribute to indicate where tag generated links should point.
Last Published: Live examples. This is version 1. Attributes Name Description Type class html pass through attribute.
String dir html pass through attribute. String id html pass through attribute. String lang html pass through attribute. String media 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.
String style html pass through attribute. String title html pass through attribute. Defaults to 'false'. String class html pass through attribute; use this instead of directly coding presentational atttributes.
String comparator The classname of comparator to use when sorting this column, or the comparator itself. Defaults to the DefaultComparator. String decorator 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. DisplaytagColumnDecorator interface. If a decorator is specified for the entire table, then this decorator will decorate that decorator. String defaultorder The default sort order for this column.
Valid values are "ascending" default or "descending" String escapeXml Set it to true to escape special characters in html and xml output. Can be used as a "shortcut" for simple column decorations. 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. String headerClass "class" html attribute added only for header cells. String headerScope "scope" html attribute added only for header cells. String href The base URL used to construct the dynamic link. An empty href value will generate a link to the current page, preserving parameters just like for paging links.
String maxLength If this attribute is provided, then the column's displayed is limited to this number of characters.
An elipse 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.
String maxWords If this attribute is provided, then the column's displayed is limited to this number of words.
String media Render the column for the media type s. The column won't be added to the table if the current request media is not supported. String nulls By default, null values don't appear in the list. By setting 'nulls' to 'true', then null values will appear as "null" in the list mostly useful for debugging. String paramId The name of the request parameter that will be dynamically added to the generated href URL.
The corresponding value is defined by the perty and optional paramName attributes, optionally scoped by the paramScope attribute. String paramName 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. String paramProperty 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. String property name of the property in the bean specified in the parent table tag via the "name" attribute mapped to this column String scope "scope" html attribute. If sortName is ommitted the value for the sort param will default to the column number.
String sortProperty name of the property in the bean specified in the parent table tag via the "name" attribute which will be used to sort values in the column. This can be used when the column body is filled or a decorator is used and column should sort on undecorated values.
String sortable Set to 'true' to make the column sortable. String title title of the column text for the th cell String titleKey Resource key used to lookup the title value. Only works if "title" is not defined.
Works together with a configured I18nResourceProvider, specified via the displaytag. String total If true, will total the contents of this column. This value is available via the Map named in varTotals for the table.
Column values need to Numbers. This attribute has the same functionality as the href attribute, but it pre-pends the contextPath. String value 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. String paramScope 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.
Attributes Name Description Type media Use this attribute to keep a footer from being output during an export. String value The value to which the property is set. You can also set the property value in the tag body. Attributes Name Description Type cellpadding html pass through attribute. Use a TableDecorator to provide custom operations against the whole list, such as computing totals.
Must extend org. String defaultorder The default order for the sorted column. Valid values are "ascending" default or "descending" String defaultsort The index of the column that will be used by default for sorting starting from 1 String excludedParams Whitespace separated list containg the name of parameters which should NOT be forwarded during paging or sorting. Valid values are true or false String frame html pass through attribute. String htmlId html "id" pass through attribute String id See "uid".
The default is false do not use sessions. Note that for this to work properly you need to assign to each table in your application a different id. String length number of records to be shown String name reference to the object used as source for the table. Can be an expression like requestScope. In the EL version of the taglibrary this must be an EL expression which points to the source object.
Valid values are true or false boolean requestURI When the present, links for sorting, exports, and paging are formed by adding any tag generated parameters to the value of requestURI attribute.
Subscribe to RSS