displaytag手册

displaytag手册

displaytag是最常用的数据表格显示标签之一.官方网址: http://displaytag.

下载地址: http:///project/showfiles.php?group_id=73068
关键api说明:
displaytag-11.jar                       必须,displayTag的主要实现APIs
displaytag-export-poi-11.jar            可选,displayTag的导出excel文件的APIs
displaytag-portlet-11.jar               可选,displayTag适配jsr168入口定义的实现APIs
依赖api说明:
commons-beanutils-170.jar               必须,apache的beanutils实现APIs
commons-collections-31.jar              必须,apache的集合加强工具类库APIs
commons-lang-21.jar                     必须,apache的java.lang加强类库
commons-logging-104.jar                 必须,apache的日志实现类库
log4j-1212.jar                          必须,apache的日志实现类库
itext-13.jar                            可选,开源的对pdf文件操作类库
运行环境说明:
displaytag目前版本是1.1;需要jdk1.4,servlet2.3,jsp1.2或更高容器支持.如果无法达到要求只能使用1.0版本.
配置属性说明:
如果你要替换修改displaytag的属性和资源文件需要把displaytag.properties加入到当前应用的classpath.
如果你只要修改某单独displaytag的属性可以使用<display:setProperty>标签.
下面陈述所有可能的配置参数和值.
basic.empty.showtable=false|true        设置当需输出的list为空时是否显示表格.默认false.为true时会输出基本表格结构并提示没数据,为false只提示没数据不产生表格html完整形式如<table><thead><tr><th></th></tr></thead><tbody></tbody></table>
basic.show.header=true                  设置在数据表格顶端是否显示表格头.默认true. 表格头可能包含每栏的标题,分页,导出数据等信息. 也就是不输出<thead><tr><th></th></tr></thead>的html
basic.msg.empty_list=Strings            设置当需输出的list为空时的提示信息.默认=Nothing found to display.该属性只有在basic.empty.showtable为false时有效.
basic.msg.empty_list_row=htmlStrings    设置当需显示的list为空时输出的信息.
                                        默认=<tr class="empty"><td colspan="{0}">Nothing found to display.</td></tr>
                                        通配符{0}指示当前table的栏为数,该整数用来设置正确的colspan,避免显示混乱.
                                        该属性只有在basic.empty.showtable为true时有效.
sort.amount=page|list                   设置对需输出的list数据在什么时机执行排序,默认=page
                                        如果=page那么list数据先分页再排序;如果=list则先整体排序后分页.
export.banner=htmlStrings               设置在启用export功能后,在表格底部显示的导出数据种类的链接html字符.
                                        默认=<div class="exportlinks">Export options: {0}</div>
                                        通配符{0}指各种导出数据的格式,可能有csv,excel,xml,pdf,rtf等
                                        实际上针对选择的各种数据文件格式都会产生相应的链接替换到位置{0}
export.banner.sepchar= |(chars)         设置启用export功能后,各导出数据类型之间的分隔符号.默认='|'
                                        它可以是任何字符,效果例如 csv|excel|xml|pdf|rtf
paging.banner.placement=top,bottom,both 设置起用分页功能后,分页信息栏出现在数据表的位置,默认=top
                                        如果为top只显示在上方,为bottom只显示在下方,为both则上下都显示.
                                        例如: sum items found,displaying pagesize to pagesize*2 [First/Prev]n..[Next/Last]
paging.banner.item_name=item            设置需输出的list包含的对象为单个时显示的名称,默认=item.通常用于国际化
paging.banner.items_name=items          设置需输出的list包含的对象为多个时显示的名称,默认=items.通常用于国际化
paging.banner.no_items_found=strings    设置启用分页功能后,list有多个数据时分页信息栏的html显示内容.
                                        默认=<span class="pagebanner">No {0} found.</span>
                                        通配符{0}指list包含的对象名称,也就是paging.banner.item_name/items_name值
paging.banner.one_item_found=strings    设置启用分页功能后,list只有一个数据时分页信息的显示内容.
                                        默认=<span class="pagebanner">One {0} found.</span>
                                        通配符{0}指list包含的对象名称,也就是paging.banner.item_name/items_name值
paging.banner.all_items_found=strings   设置启用分页功能后list可以一次显示完的显示信息内容.
                                        默认=<span class="pagebanner">{0} {1} found, displaying all {2}.</span>
                                        占位符{0}和{2}替换为list长度,{1}替换为list包含对象的名称.
paging.banner.some_items_found=strings  设置启用分页功能后,多页时显示的分页信息.
                                        默认=<span class="pagebanner">{0} {1} found, displaying {2} to {3}.</span>
                                        {0}是总数,{1}是对象名称,{2}是当前起始点,{3}是当前结束点.
paging.banner.group_size=8              设置启用分页功能后,如果有多页,需要显示页面跳转的个数.默认=8.
paging.banner.full=strings              设置分页的换页信息.默认=<span class="pagelinks">
                                        [<a href="{1}">First</a>/<a href="{2}">Prev</a>] {0} [<a href="{3}">
                                        Next</a>/<a href="{4}">Last</a>]</span>
                                        {0}是group_size的数值连接,{1}是连接到第一页,{2}是连接到前一页
                                        {3}是连接到下一页,{4}是连接到最后一页
paging.banner.first=strings             设置显示第一页时的分页栏信息,默认=<span class="pagelinks">[First/Prev] {0}
                                        [<a href="{3}">Next</a>/<a href="{4}">Last</a>]</span>
                                        占位符的值和full属性相同
paging.banner.last=strings              设置显示最后一页时的分页栏信息.默认=<span class="pagelinks">
                                        [<a href="{1}">First</a>/<a href="{2}">Prev</a>] {0} [Next/Last]</span>
                                        占位符的值和full属性相同
paging.banner.onepage=strings           只有一页时的分页栏显示信息,默认=<span class="pagelinks">{0}</span>
paging.banner.page.selected=strings     设置多页时选择了某页时的显示信息,默认=<strong>{0}</strong>
paging.banner.page.link=strings         设置分页的连接信息<a href="{1}" title="Go to page {0}">{0}</a>
                                        占位符{0}是页码,{1}是访问页面的连接
paging.banner.page.separator=, \        设置各页码间的分隔符号,默认=','
factory.decorator=classpath             设置输出list数据的装饰类的java全限定名,
                                        默认=org.displaytag.decorator.DefaultDecoratorFactory
factory.requestHelper=classpath         设置实现RequestHelperFactory的类名.需要displaytag-portlet-11.jar包
                                        默认=org.displaytag.util.DefaultRequestHelperFactory
export.types=csv excel xml pdf rtf      设置支持的导出文件类型
export.csv=true                         设置标签是否应该转化成cvs格式导出
export.excel=true                       设置标签是否应该转化成excel格式导出
export.xml=true                         设置标签是否应该转化成xml格式导出
export.pdf=false                        设置标签是否应该转化成pdf格式导出
export.rtf=false                        设置标签是否应该转化成rtf格式导出
export.csv.class=classpath              设置标签实现数据导出的装饰java类名,默认=org.displaytag.export.CsvView
export.excel.class=classpath            设置标签实现数据导出的装饰java类名,默认=org.displaytag.export.ExcelView
export.xml.class=classpath              设置标签实现数据导出的装饰java类名,默认=org.displaytag.export.XmlView
export.pdf.class=classpath              设置标签实现数据导出的装饰java类名,默认=org.displaytag.export.PdfView
export.csv.label=strings                设置转换格式显示的文本,默认=<span class="export csv">CVS </span>
export.excel.label=strings              设置转换格式显示的文本,默认=<span class="export excel">EXCEL </span>
export.xml.label=strings                设置转换格式显示的文本,默认=<span class="export xml">XML </span>
export.pdf.label=strings                设置转换格式显示的文本,默认=<span class="export pdf">PDF </span>
export.rtf.label=strings                设置转换格式显示的文本,默认=<span class="export rtf">RTF </span>
export.csv.include_header=true|false    设置导出数据时是否在目标文件里加入当前表格的表头,默认=false
export.excel.include_header=true|false  设置导出数据时是否在目标文件里加入当前表格的表头,默认=true
export.xml.include_header=true|false    设置导出数据时是否在目标文件里加入当前表格的表头,默认=true
export.pdf.include_header=true|false    设置导出数据时是否在目标文件里加入当前表格的表头,默认=true
export.rtf.include_header=true|false    设置导出数据时是否在目标文件里加入当前表格的表头,默认=true
export.csv.filename=strings             设置导出的文件名
export.excel.filename=strings           设置导出的文件名
export.xml.filename=strings             设置导出的文件名
export.pdf.filename=strings             设置导出的文件名
export.rtf.filename=strings             设置导出的文件名
export.amount=page, list                设置导出数据时是对全部list数据还是只对当前page的数据执行导出,默认=page
export.decorated=true, false            设置如果有装饰类,那么是否对导出的数据也经过装饰类过滤,默认=true
css.tr.even=even                        设置数据表偶数行的显示样式,默认=even,可以是任何css的class名
css.tr.odd=odd                          设置数据表奇数行的显示样式,默认=odd,可以是任何css的class名
css.th.sorted=sorted                    设置可排序栏位已排序头的css样式,默认=sorted,可以是任何css的class名
css.th.ascending=order1                 设置可排序栏位头升序的css样式,默认=order1,可以是任何css的class名
css.th.descending=order2                设置可排序栏位头降序的css样式,默认=order2,可以是任何css的class名
css.table=                              设置可排序栏位的css样式,默认=sorted,可以是任何css的class名
css.th.sortable=sortable                设置可排序栏位可排序的css样式,默认=sortable,可以是任何css的class名
标签属性说明
<display:caption>                       产生一个<caption></caption>标记,可以包含jsp文件.
class          简单的css的class名
dir            文字读写方向
id             caption标记的id
lang           caption标记的lang属性
media          导出数据的文件类型,默认=all,多个值用空格分开,例如 csv excel xml pdf rtf
style          设置样式
title          设置title属性,鼠标停留将会显示该文本.
<display:column>                        产生数据表格中的一栏,每笔记录将按属性填充到该栏
autolink       boolean,如果为true将数据装饰成一个地址超连接,形如<a href="values...mailto:values...">values...</a>默认=false
class          该栏css的class名称,将覆盖上层css
comparator     java全限定名,用于实现该栏数据排序的比较运算,必须实现Comparator接口,默认=DefaultComparator
decorator      java全限定名,用于装饰该栏数据显示,必须实现DisplaytagColumnDecorator接口
defaultorder   设置默认排序规则,ascending或descending,默认是升序
escapeXml      boolean,是否对特殊字符过滤转换.默认false
format         设置对国际化数据的格式化格式,例如money,date等
group          设置分组显示的深度数值,以1开始累加.可以对查询出来的重复数据屏蔽显示,当低数值不再匹配后会继续分组高数值的栏.
headerClass    对数据表头的样式class名称.
headerScope    对表头加scope属性
href           超连接的地址
maxLength      当前栏的最大显示字符数,超过将以...替换超出的,并在鼠标停留是显示全部.
maxWords       当前栏的最大显示文字数,超过将以...替换超出的,并在鼠标停留是显示全部.
media          导出数据的文件类型,默认=all,多个值用空格分开,例如 csv excel xml pdf rtf
nulls          boolean,对为null的数据不显示'null'而是以空白代替.默认=false
paramId        附加到url上的参数名称.如果没特别指定,参数值就是当前栏的值.
paramName      在paramScope指定的范围里查找paramName指定的属性并把属性值加到paramId为名称的url参数里面.
paramProperty  在当前list的数据里面查找paramProperty指定的属性的值加到paramId为名称的url参数里面.
property       当前list里面存储的属性名,会自动匹配并输出其值.
scope          当前数据的范围,page,request,session,appliaction
sortName       指定排序的属性名称.如果值未指定,默认为_rowNum值,也就是当前行号
sortProperty   指定需要排序的属性.
sortable       boolean,指定当前栏是否需要排序,如果为true那么所有排序的对象必须实现了Comparator接口.默认=false
style          当前栏的样式
title          设置当前栏的title属性值
titleKey       国际化属性,用来根据该key值到资源文件里面取回实际的title文本.
total          boolean,是否对当前栏的所有数据进行汇总计算.默认=false
url            和herf一样的url设置
value          填充到栏位的文本值
paramScope     配合paramName用来指定查找的范围
<display:footer>                        显示表格底部的标签,可以包含jsp文件
media          指定导出数据时的文件格式类型,默认=all,多个值用空格分开,例如 csv excel xml pdf rtf
<display:setProperty>                   重新设置当前表格的配置属性,参见前面的displaytag.properties文件
name           必须,需要配置属性的名称
value          对name更新的值
<display:table>                         创建一个数据表格
cellpadding    表格属性
cellspacing    表格属性
class          表格属性
decorator      对整个list的装饰类,java全限定名
defaultorder   对整个list排序的排序规则,ascending或descending,默认是升序
defaultsort    默认排序的栏,整数,以1开始
excludedParams 排除出参数之外的参数列表,以空格分开
export         boolean,是否可以导出成指定的文件格式,默认false
frame          html属性
htmlId         对应html的id属性
id             唯一标示该displaytag实例的标示符,不可以包含运行期的表达式
length         最长的显示记录数
list           指示用于填充数据表的数据集合list名称,一般用name代替
name           存储在访问范围内的数据集合对象的名称,tag会在page,request等范围查找该对象并取回数据填充表格
offset         取回list数据中的偏移整数值,用于分页
pagesize       每页显示的最大记录数,用于分页
partialList    是否可以使用list的子集合来填充数据
requestURI     如果出现,该url值会自动添加到其他url前面
requestURIcontext boolean,是否自动使用request上下文里面的url.
rules          html属性
size           当partialList设为true时才有用,用来设置每次取回的子集合长度
sort           page或list,设置排序发生的时机
style          html样式
summary        html属性
uid            唯一表示当前displaytag实例的名称.可以用uid_rowNum表示当前行,并引用所有集合内数据.该值必须页面内唯一
varTotals      定义一个存储所有行数和值的map.

可能有些理解错误,并没有全部测试.