DisplayTag应用指南

DisplayTag是一个非常好用的表格显示标签，适合MVC模式，其主页在http://displaytag.sourceforge.net/ 
一、最简单的情况，未使用<display:column/>标签
  <%request.setAttribute( "test", new ReportList(6) );%>
  <display:table name="test" />
  标签遍历List里的每一个对象，并将对象里的所有属性显示出来。一般用于开发的时候检查对象数据的完整性。
 
二、使用<display:column/>标签的情况
<display:table name="test">
  <display:column property="id" title="ID" />
  <display:column property="name" />
  <display:column property="email" />
  <display:column property="status" />
  <display:column property="description" title="Comments"/>
</display:table>
   property对应List里对象的属性（用getXXX()方法取得），title则对应表格表头里的列名。定义列有两种方式：
   A、<display:column property="email" />
      使用<display:column/>标签里的property属性来定义
   B、<display:column title="email">[e-mail]</display:column>
      在<display:column/>标签体里增加内容，可以是常量，也可以用其他标签等等
   两种方式比较，用property属性来定义更加快速和利于排序。
  
三、表格显示样式的定义
  A、在<display:table/>和<display:column/>标签里指定标准的html属性，烦琐
  B、修改样式表
<display:table name="test" class="mars">
  <display:column property="id" title="ID" class="idcol"/>
  <display:column property="name" />
  <display:column property="email" />
  <display:column property="status" class="tableCellError" />
  <display:column property="description" title="Comments"/>
</display:table>
   通过class属性来指定所要应用的样式。可以在其默认样式表里（./css/screen.css）直接修改
  
四、标签取得数据的数据源
  有四种范围
   pageScope
   requestScope (默认)  <display:table name="test2" >
   sessionScope  <display:table name="sessionScope.holder.list" > 注意，这里要指定范围，非默认
   applicationScope
  
五、通过增加id属性创建隐含的对象
<display:table name="test" id="testit">
    <display:column property="id" title="ID" />
    <display:column property="name" />
    <display:column title="static value">static</display:column>
    <display:column title="row number (testit_rowNum)"><%=pageContext.getAttribute("testit_rowNum")%></display:column>
    <display:column title="((ListObject)testit).getMoney()"><%=((ListObject)pageContext.getAttribute("testit")).getMoney()%></display:column>
</display:table>
   注意到在<display:table/>里增加了id属性，这时就在page context里创建了一个隐含对象，指向List里的当前对象，
   可以通过(ListObject)pageContext.getAttribute("id")来捕获这个对象。同时还创建了一个id_rowNum对象，同样，可
   通过pageContext.getAttribute("testit_rowNum")来捕获，它仅仅代表当前行的行数。
   有了这两个隐含对象，就可以通过其他标签来访问，例如Jstl:
  <display:table id="row" name="mylist">
    <display:column title="row number" >
      <c:out value="${row_rowNum}"/>
    </display:column>
    <display:column title="name" >
      <c:out value="${row.first_name}"/>
      <c:out value="${row.last_name}"/>
    </display:column>
  </display:table>
 
六、显示部分数据
   显示开始五条数据：通过设定length属性
<display:table name="test" length="5">
  <display:column property="id" title="ID" />
  <display:column property="email" />
  <display:column property="status" />
</display:table>
   显示第三到第八条数据：通过设定offset和length属性
<display:table name="test" offset="3" length="5">
  <display:column property="id" title="ID" />
  <display:column property="email" />
  <display:column property="status" />
</display:table> 

七、对email和url地址的直接连接
<display:table name="test" >
  <display:column property="id" title="ID" />
  <display:column property="email" autolink="true" />
  <display:column property="url" autolink="true" />
</display:table>
如果要显示的对象里包含email和url地址，则可以在display:column里直接设定autolink="true"来直接连接

八、使用装饰模式转换数据显示（写自己的 decorator ）
  A、对整个表格应用decorator
  <display:table name="test" decorator="org.displaytag.sample.Wrapper" >
      <display:column property="id" title="ID" />
      <display:column property="email" />
      <display:column property="status" />
      <display:column property="date" />
      <display:column property="money" />
  </display:table>
    org.displaytag.sample.Wrapper即自己写的decorator，它要继承TableDecorator类，看看它的一个方法：
        public String getMoney()
    {
        return this.moneyFormat.format(((ListObject) this.getCurrentRowObject()).getMoney());
    }
    很明显，它通过父类的getCurrentRowObject()方法获得当前对象，然后对其getMoney()方法进行‘油漆’
  B、对单独的column应用decorator
  <display:table name="test">
     <display:column property="id" title="ID" />
     <display:column property="email" />
     <display:column property="status" />
     <display:column property="date" decorator="org.displaytag.sample.LongDateWrapper" />
  </display:table>
    org.displaytag.sample.LongDateWrapper要实现ColumnDecorator接口，它的方法：
        public final String decorate(Object columnValue)
    {
        Date date = (Date) columnValue;
        return this.dateFormat.format(date);
    }
    显然，它获得不了当前对象（因为它实现的是接口），仅仅是获得该对象的columnValue，然后‘油漆’
   
九、创建动态连接
   有两种方法创建动态连接：
   A、在<display:column/>里通过增加href、paramId、paramName、paramScope、paramProperty属性
      href             基本的URL 地址
      paramId          加在URL 地址后的参数名称
      paramName        数据bean的名称，一般为null（即使用当前List里的对象）
      paramScope       数据bean的范围，一般为null
      paramProperty    数据bean的属性名称，用来填充URL 地址后的参数值
<display:table name="sessionScope.details">
  <display:column property="id" title="ID" href="details.jsp" paramId="id" />
  <display:column property="email" href="details.jsp" paramId="action" paramName="testparam" paramScope="request" />
  <display:column property="status" href="details.jsp" paramId="id" paramProperty="id" />
</display:table> 
    这种方法简便直接，但缺点是无法产生类似details.jsp?id=xx&action=xx的复合URL
   B、应用decorator 创建动态连接：
<display:table name="sessionScope.details" decorator="org.displaytag.sample.Wrapper" >
  <display:column property="link1" title="ID" />
  <display:column property="email" />
  <display:column property="link2" title="Actions" />
</display:table>
   org.displaytag.sample.Wrapper里的方法：
    public String getLink1()
    {
        ListObject lObject= (ListObject)getCurrentRowObject();
        int lIndex= getListIndex();
        return "<a href=\"details.jsp?index=" + lIndex + "\">" + lObject.getId() + "</a>";
    }


    public String getLink2()
    {
        ListObject lObject= (ListObject)getCurrentRowObject();
        int lId= lObject.getId();

        return "<a href=\"details.jsp?id=" + lId
            + "&action=view\">View</a> | "
            + "<a href=\"details.jsp?id=" + lId
            + "&action=edit\">Edit</a> | "
            + "<a href=\"details.jsp?id=" + lId
            + "&action=delete\">Delete</a>";
    }

十、分页
   实现分页非常的简单，增加一个pagesize属性指定一次想显示的行数即可
<display:table name="sessionScope.test" pagesize="10">
    <display:column property="id" title="ID" />
    <display:column property="name" />
    <display:column property="email" />
    <display:column property="status" />
</display:table>

十一、排序
   排序实现也是很简单，在需要排序的column里增加sortable="true"属性，headerClass="sortable"仅仅是
   指定显示的样式。column里的属性对象要实现Comparable接口，如果没有的话可以应用decorator
   defaultsort="1"              默认第一个column排序
   defaultorder="descending"    默认递减排序
<display:table name="sessionScope.stest" defaultsort="1" defaultorder="descending">
  <display:column property="id" title="ID" sortable="true" headerClass="sortable" />
  <display:column property="name" sortable="true" headerClass="sortable"/>
  <display:column property="email" />
  <display:column property="status" sortable="true" headerClass="sortable"/>
</display:table>
  注意的是，当同时存在分页时如果不指定sort=list,则排序仅仅针对的是当前页面，而不是整个List都进行排序
 
十二、column 分组
   分组只是需要在column里增加group属性
<display:table name="test" class="simple">
  <display:column property="city" title="CITY" group="1"/>
  <display:column property="project" title="PROJECT" group="2"/>
  <display:column property="amount" title="HOURS"/>
  <display:column property="task" title="TASK"/>
</display:table>

十三、导出数据到其他格式（页面溢出filter??）
   在<display:table/>里设定export="true"
   在<display:column/>里设定media="csv excel xml pdf" 决定该字段在导出到其他格式时被包不包含，不设定则都包含
   <display:setProperty name="export.csv" value="false" />
   决定该种格式能不能在页面中导出
<display:table name="test" export="true" id="currentRowObject">
  <display:column property="id" title="ID"/>
  <display:column property="email" />
  <display:column property="status" />
  <display:column property="longDescription" media="csv excel xml pdf" title="Not On HTML"/>
  <display:column media="csv excel" title="URL" property="url"/>
  <display:setProperty name="export.pdf" value="true" />
  <display:setProperty name="export.csv" value="false" />
</display:table>

十四、配置属性，覆盖默认
  两种方法：
  A、在程序classpath下新建displaytag.properties文件
  B、对于单个表格，应用<display:setProperty>标签
  具体可配置的属性：http://displaytag.sourceforge.net/configuration.html
 
十五、一个完整的例子
<display:table name="test" export="true" sort="list" pagesize="8">
  <display:column property="city" title="CITY" group="1" sortable="true" headerClass="sortable"/>
  <display:column property="project" title="PROJECT" group="2" sortable="true" headerClass="sortable"/>
  <display:column property="amount" title="HOURS"/>
  <display:column property="task" title="TASK"/>
</display:table>
   sort="list" 对整个list进行排序
   导出数据到其他格式时，group无效

评论

17 楼 suyulin6688 2007-09-11  

我使用displaytag遇到一个问题：

我在一个struts action类（配置为“a.do”）中处理完之后，传递一个list给页面“a.jsp”，

“a.jsp”使用displaytag来显示list的内容，

但是导出数据时（例如导出为EXCEL和PDF格式的文件），导出的EXCEL和PDF文件是空的，里面没有内容，

因为我看到“a.jsp”里面显示的导出链接是“a.jsp?......”，

而不是我希望的“a.do?......”。

该怎么解决呢？

16 楼 fins 2007-05-30  

我觉得 dt没有ec好 ec没有ecside好 呵呵

而且dt好久没更新了吧 似乎是个死掉的项目了

用着不放心

15 楼 free_zk 2007-05-30  

增加经验了，好文章。

14 楼 moshalanye 2007-05-28  

    对于displaytage，总的来说毕竟是现成的东西，使用起来可以减少项目中的bug，而对于displaytage分页，不大赞成从前台拿到page，sort，dir等等之类的参数在后台不加使用，直接从数据库取出所有的数据list或是pagination放到显示的.jsp叶面的displaytage中，让其使用上次提交的page，sort。。的参数去分叶排序，这样取的数据很多都没用到，还是自己在后台用前台用这些参数去拼装sql比较好，同时可以在查数据的前查数据库中的总数据量来判断是否约界，并可以做出响应处理
    而且在在displaytage使用type为page来进行排序往往会遇到很多的问题，这个是你在传数组的情况下肯定没办法做的，一般使用有map这种有key，value对应或是object有属性和value对应的形式，但是在排序有比较特别的时候，还需要你去改写display中的用来提供比较compare的一个类，实在用起来效率和好用度都不高，建议还是使用它的导出和减少叶面的代码量来合理使用，毕竟在动态传递分叶排序的参数时，display还是蛮好用的
    而且在使用displaytage时有些小地方的使用还会遇到一些问题，比如在点排序的时候page这个参数是不在display的产生的url上，而在保存分叶表单的时候，由于dispalytage是把参数放在url，而我们如果在保存表单的时候是使用表单会面临参数覆盖的问题，这个比较细节需要自己合理处理
    至于displaytag在type为list的使用上，一般都是在有这样把所有数据全部显示出来的需求时有用，但是当type为list的时候，由tag产生的排序之类的参数是个比较难懂的参数，而且好象有人说这个参数名的产生跟jre和环境有关，当时在完成这样类似的需求后，考虑到参数名的不确定还是改成了在查到所有数据后在paginaiton中把最大叶数设成比总数大一的数字（的确有点不大舒服，不知道在这个参数名的产生上，谁知道，也可以告诉我，顺便学习下）

13 楼 Puras 2007-05-28  

在06年初的时候用过了
翻页处理的很烂
得自己实现
只在小项目中用了用
不知道现在发展什么样了

12 楼 caochuncheng2002 2007-05-28  

ronghao 写道

楼主,这文章好象不是你写的吧

不知道出处呀.其它地方也可以看得到.呵

11 楼 pipi2142001 2007-05-04  

萝卜白菜，各有所爱

10 楼 welllove53 2006-09-25  

出来到哪个时候，DT实在不能满足我的需求了，再换EC

9 楼 lordhong 2006-09-25  

现在支持数据库resultset，但用list来实现的话比较灵活

8 楼 Tin 2006-09-25  

Display Tag 1.1已经支持External Paging and Sorting了。也就是可以不用一次调出完整List了。
DT比起EC用户群大一些吧，老早就有好多人用，默认的css也比较漂亮。
EC从架构上比DT好，适合自己扩展，从技术上领先DT。国内现在很多朋友在用，用户群不错的，有http://groups.google.com/group/eXtremeComponents_CN

我觉得以前就DT则可以继续用。新应用的Table组件可以优先考虑EC。

7 楼 galaxystar 2006-09-25  

请问，是不是基于表单的？
如果配置的property一样，是提交数组吗？

6 楼 ronghao 2006-09-25  

DisplayTag我去年使用的时候是不支持数据库分页的,后来1.0版本说支持,后来也没再用过了

5 楼 ronghao 2006-09-25  

楼主,这文章好象不是你写的吧

4 楼 stamen 2006-09-24  

不知道和sourceforge的TableTag  以及eXtremeTable比较起来 哪个更好用些？

3 楼 lordhong 2006-09-24  

基本上是通过一个List类的object来实现的

2 楼 liuyxit 2006-09-24  

能否介绍一下分页和排序的原理?

本人没用过,不知它的效率怎样.TKS

1 楼 lordhong 2006-09-24  

和jstl一起用，效果很好！