1.0-rc1 1.2 display http://displaytag.sf.net Display *: Tag Library 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. table org.displaytag.tags.TableTag org.displaytag.tags.TableTagExtraInfo JSP table 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. Supports the export of the list data to alternative formats such as CSV, Excel, and XML. 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. list false true Reference to the object used as source for the table. Can be an expression like requestScope.object.property . You must define either the name attribute or the list attribute. List is suggested. name false true reference to the object used as source for the table. Can be an expression like requestScope.object.property. In the EL version of the taglibrary this must be an EL expression which points to the source object. property false true java.lang.String @deprecated in displaytag 1.0. Use list.property in "name" attribute. Not supported in the EL version of the tag. scope false true java.lang.String @deprecated in displaytag 1.0. Use "pageScope.", "requestScope.", "sessionScope.", "applicationScope." prefixes in name. Not supported in the EL version of the tag. length false true int number of records to be shown offset false true int index of the first record to be shown pagesize false true int number of records in a page decorator false true java.lang.String Fully qualified class name for a TableDecorator. Use a TableDecorator to provide custom operations against the whole list, such as computing totals. Must extend org.displaytag.decorator.TableDecorator. requestURI false true java.lang.String When the present, links for sorting, exports, and paging are formed by adding any tag generated parameters to the value of requestURI attribute. width false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. style false true java.lang.String html pass through attribute class false true java.lang.String html pass through attribute styleClass false true java.lang.String @deprecated: use "class" border false true java.lang.String @deprecated html pass through attribute. Use css "border" cellspacing false true java.lang.String html pass through attribute cellpadding false true java.lang.String html pass through attribute. Better using "padding" css attribute in style or class align false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. background false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. bgcolor false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. frame false true java.lang.String html pass through attribute. height false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. hspace false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. rules false true java.lang.String html pass through attribute. summary false true java.lang.String html pass through attribute vspace false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. export false true boolean enable/disable export. Valid values are true or false id false true java.lang.String An implicit variable of this name will be created and placed into NESTED scope. The object is also added to pageContext under this name. sort false true java.lang.String Use 'page' if you want to sort only visible records, or 'list' if you want to sort the full list defaultsort false true int The index of the column that will be used by default for sorting (starting from 1) defaultorder false true java.lang.String The default order for the sorted column. Valid values are "ascending" (default) or "descending" ]]> column org.displaytag.tags.ColumnTag JSP column 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. property false true java.lang.String name of the property in the bean specified in the parent table tag (via the "name" attribute) mapped to this column title false true java.lang.String title of the column (text for the th cell) nulls false true boolean 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). Defaults to 'false'. sort false true boolean @deprecated: use "sortable" sortable false true boolean Set to 'true' to make the column sortable. Defaults to 'false'. autolink false true boolean Automatically hyperlink URLs and email addresses that appear in the column. Defaults to 'false'. media false true java.lang.String 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. href false true java.lang.String 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. url false true java.lang.String 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. paramId false true java.lang.String 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. paramName false true java.lang.String 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. paramProperty false true java.lang.String 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). paramScope false true java.lang.String @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. maxLength false true int 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. maxWords false true int 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. width false true java.lang.String @deprecated; html attribute. Use "style" or "class" to set presentational attributes using css. class false true java.lang.String html pass through attribute; use this instead of directly coding presentational atttributes. styleClass false true java.lang.String @deprecated: use "class" headerClass false true java.lang.String "class" html attribute added only for header cells. headerStyleClass false true java.lang.String @deprecated: use "headerClass" style false true java.lang.String html pass through attribute. align false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. background false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. bgcolor false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. height false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. nowrap false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. valign false true java.lang.String @deprecated html attribute. Use "style" or "class" to set presentational attributes using css. group false true int 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. decorator false true java.lang.String The fully qualified class name of a class that should be used to "decorate" the underlying object being displayed. The class should implement org.displaytag.decorator.ColumnDecorator. If a decorator is specified for the entire table, then this decorator will decorate that decorator. setProperty org.displaytag.tags.SetPropertyTag JSP setProperty 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. name true true java.lang.String The name of the property to set on the enclosing Table tag. value false true java.lang.String The value to which the property is set. You can also set the property value in the tag body. or bottom ]]> footer org.displaytag.tags.TableFooterTag JSP footer Tag wich should be nested into a table tag to provide a custom table footer. The body of the tag is outputted as is in the generated table in the tfoot section. total: ]]> caption org.displaytag.tags.CaptionTag JSP caption Simple tag which mimics the html caption tag. Use it inside a table tag to display a caption. style false true java.lang.String html pass through attribute. class false true java.lang.String html pass through attribute. id false true java.lang.String html pass through attribute. title false true java.lang.String html pass through attribute. lang false true java.lang.String html pass through attribute. dir false true java.lang.String html pass through attribute. This is the table caption ]]>