| Attributes |
| Name | Required | Request-time | Type | Description |
| 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 |
| sortProperty | false | true | java.lang.String | 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 undeorated values. |
| title | false | true | java.lang.String | title of the column (text for the th cell) |
| comparator | false | true | java.lang.String | The classname of comparator to use when sorting this column, or the comparator itself. Defaults to the DefaultComparator. |
| titleKey | false | true | java.lang.String | 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.properties file. By default, if JSTL is available, the JSTL provider is used, which makes this attribute work the same as fmt:message's key property. |
| 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'. |
| total | false | true | boolean | 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. |
| sortable | false | true | boolean | Set to 'true' to make the column sortable. Defaults to 'false'. |
| defaultorder | false | true | java.lang.String | The default sort order for this column. Valid values are "ascending" (default) or "descending" |
| autolink | false | true | boolean | Automatically hyperlink URLs and email addresses that appear in the column. Defaults to 'false'. |
| format | false | true | java.lang.String | 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 |
| escapeXml | false | true | boolean | Set it to true to escape special characters in html and xml output. Defaults to 'false'. @since 1.1 |
| 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 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. |
| 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. 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. |
| 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. 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. |
| class | false | true | java.lang.String | html pass through attribute; use this instead of directly coding presentational atttributes. |
| headerClass | false | true | java.lang.String | "class" html attribute added only for header cells. |
| style | false | true | java.lang.String | html pass through attribute. |
| 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 | 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. |
| sortName | false | true | java.lang.String | 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. |
| headerScope | false | true | java.lang.String | "scope" html attribute added only for header cells. |
| scope | false | true | java.lang.String | "scope" html attribute. |
| value | false | true | java.lang.Object | 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. |