Display tag 的使用

     Display Tag Lib是一个标签库，用来处理jsp网页上的Table，功能非常强，可以对的Table进行分页、数据导出、分组、对列排序等等，反正我在做项目时需要的功能它都给我提供了，而且使用起来非常的方便。能够大大减少代码量。
    这个是Display Tag的官方网站http://displaytag.sourceforge.net。目前好像无法访问了。。。

    首先当然是要下载它的jar包了，这里可以下载到最新的版本。将jar包放到WEB-INF的lib文件夹下。另外还需要两个辅助包：apache的commons-lang和standard包，更多的辅助包可以在这里下载。

    在web.xml下添加一个filter
    <filter>
        <filter-name>exportFilter</filter-name>
        <filter-class>org.displaytag.filter.ResponseOverrideFilter</filter-class>
    </filter>

    在jsp页面做一个引用：
<%@ taglib uri="http://displaytag.sf.net/el" prefix="display" %>

    首先我们定义一个list
<%
 List test = new ArrayList( 6 );
 test.add( "Test String 1" );
 test.add( "Test String 2" );
 test.add( "Test String 3" );
 test.add( "Test String 4" );
 test.add( "Test String 5" );
 test.add( "Test String 6" );
 request.setAttribute( "test", test );
%>

    当我们想在jsp页面上显示这个list时，我们只需要写一句话
    <display:table name="test" />
    display tag会自动生成一个table

    如果list是从控制层抛出来的，name可使用EL表达式表示
    <display:table name="${test}" />

    这是最简单的display tag的使用，我们可以给它加上样式等，也可以定义显示的列，下面的table显示复杂一些
<display:table name="test" styleClass="list" cellspacing="0" cellpadding="0">
  <display:column property="id" title="ID" class="idcol"/>
  <display:column property="name" />
  <display:column property="email" />
  <display:column property="description" title="Comments"/>
</display:table>

    如果想要给它加个链接也很简单,下面的代码给name加了连接，并附带id参数，email也自动连接到mailto:XXX
<display:table name="test" styleClass="list" cellspacing="0" cellpadding="0">
  <display:column property="id" title="ID" class="idcol"/>
  <display:column property="name" url="detail.jsp" paramId="id" paramProperty="id"/>
  <display:column property="email" autolink="true"/>
  <display:column property="description" title="Comments"/>
</display:table>

下面介绍几个Display最常用的功能，更多功能请参考http://displaytag.homeip.net/displaytag-examples-1.1/。
1. 分页
    如果想对代码分页，只需在display:table标签中添加一项pagesize="每页显示行数"，如
<display:table name="test" pagesize="10"/>

 

2. 对列排序
    display tag可对列进行排序，就是点击列名，对该列的数据进行排序。你只需对想要排序的列添加 sort="true" 就OK，如下面的代码可对前三列进行排序。在display:table中添加defaultsort="列数"，可默认对指定的列排序。
<display:table name="test" styleClass="list" cellspacing="0" cellpadding="0" defaultsort="1">
  <display:column property="id" title="ID" class="idcol" sort="true"/>
  <display:column property="name" url="detail.jsp" paramId="id" paramProperty="id" sort="true"/>
  <display:column property="email" autolink="true" sort="true"/>
  <display:column property="description" title="Comments"/>
</display:table>
   如果table有分页，Display Tag默认只对当前页进行排序，如果想对整个list排序，可以在display:table之间添加一段代码：
<display:setProperty name="sort.amount" value="list"/>

3. 导出数据
    在display:table中添加export="true"，看看会出现什么！Display Tag默认会提供三种数据导出方式：CSV、Excel、XML 。
    另外Display Tag还可以导出为PDF格式，在http://prdownloads.sourceforge.net/itext/下载一个辅助包iText.jar，copy到lib目录下，然后在display:table之间添加一段代码：
<display:setProperty name="export.pdf" value="true"/>，大功告成。

 

4. Display Tag的属性设置
    前面所说的display:setProperty 是一种改变Display Tag属性的方法，但是在每个jsp中都要写太麻烦了。
    Display Tag中设置了很多默认的属性，它有一个专门的属性文件，是在它的jar包中的displaytag/properties/TableTag.properties
    想要改变它的默认属性，我们可以在WEB-INF/classes下新建一个文件displaytag.properties，仿照TableTag.properties中属性的格式设置需要修改的属性。
    TableTag.properties中的# messages中设置的是显示在页面上的提示信息。默认是英文的，我们可以把它改为中文的。不过这里只能使用unicode，就是说中文字符必须转换为 unicode码，这个可以使用jdk自带的native2ascii.exe进行转换。

 

5. 其它功能
    DisplayTag还有一些很实用的小功能，这里提两个。一个是对数据的Format，这是1.1版本添加的新功能，可以使用标签的方式格式化时间、数 字、字符串。比如日期，在需要格式化的column标签中添加format="{0,date,yyyy-MM-dd}"，第一个参数为格式化的数据序 号，第二个参数是数据类型，数字为number，第三个参数为数据格式。
    另外一个功能是对table数据的合计功能。在table标签中添加 decorator="org.displaytag.decorator.TotalTableDecorator"，然后在想要进行合计的数据列的 column标签中添加 total="true"，该列就可以被计算总数了。但这个功能有个缺点，不能用在有分页的时候，它只能合计第一页的数据。

DisplayTag的不足
    初次使用DisplayTag的人可能会觉得惊喜，但是用久了会发现很多问题，最大的问题是对中文的支持不好，比如如果查询条件中有中文，就无法翻页，无 法对中文排序，将中文导出为指定文件时出现乱码等等。这些问题有时候会让人很郁闷，有时候逼得你要去修改它的源代码。下面是对以上几个问题的解决方法：
    1. 对于中文无法翻页、排序，最简单的办法是修改Tomcat下的server.xml文件。找到HTTP的Connector标签，在里面添加一项 URIEncoding="..."，引号里面的内容取决于你的页面编码，比如可以是GBK，UTF8等。这样上面两个问题就可以解决了。
    2. 导出为文件：其实这个功能除了中文支持外还有很多其它问题，比如它会将Html标签一起导出、只导出显示的内容，但如果对table进行了 decorator，decorator后的内容无法导出。如果想要将中文正确导出，需要修改DisplayTag源代码。
    下载相同版本的源代码，在org.displaytag.export.ExcelView.java文件中找到getMimeType()方法，将此方 法修改为 return "application/vnd.ms-excel;charset=GB2312";，修改后导出数据的速度会慢很多，不过将就吧。
    3. 新版的DisplayTag1.1添加了对一次取部分数据的支持，相关的标签包括partialList和size，需要设置partialList="true"和size的大小。具体怎么用偶还没研究。

 

 

 

 

 

首先，墨守成规地把这几天的学习内容罗列一下。

 

然后，根据displaytag具有的缺陷以及解决办法提出自己的无限失望。

 

好，开始列了，

 

displaytag 学习笔记总结(1)

 

6,列表的子集
 <display:table name="mylist" offset="m" length="n"/>
 offset 为第一个数据在mylist中的序号。
 length 为显示的记录条数。

 

7，自动设置链接
 能够把此列的内容作为链接，连接的url和内容一致。
    当然必须格式有效的url，否则写了也没有连接。

 

 （
  自认为这个功能一般。
  因为连接的内容和显示的内容通常不一样。
  ）
 当然可以在<display:column href="">在这里给某列指定所有的链接为同一个连接。
 或者<display:column ><a href="">sdfs</a></display:column >两者效果是一样的。

 

 ！！！那么，如果连接的url不是列内容，而且每行的链接都不相同，这个时候怎么办？
  就好像广告列表有商户名称，商户名称是一个连接，连接到商户的具体信息页面。
  连接的url肯定不同。如何处理？
 
 现在还不知道，接着往下看。

 

8，使用装饰类来转换数据。
 

 

 <display:table name="test" decorator="org.displaytag.sample.Wrapper" >
 用来转换数据内容的。一般用来格式化信息。
 此类必继承TableDecorator。
 顺便介绍一个格式化时间的包  org.apache.commons.lang.time.FastDateFormat;
 格式化金钱的包  java.text.DecimalFormat;
 
 思路就是覆盖List中具体类型的getXXX方法。
 this.getCurrentRowObject() 得到当前行的数据。
 this.getListIndex() 得到当前行的序号。
 之后就转化为List中存放的具体类型，之后得到某列的数据。
 返回格式化后的数据。

 

 ！！！！另外我看到，装饰类增加了一些getXXX方法，这些方法并没有在ListObject中定义。
 还不知道这样做有什么好处？
 
  <display:column property="date" decorator="org.displaytag.sample.LongDateWrapper" />
 这样仅仅对一列数据进行格式化，需要继承ColumnDecorator
 需要实现：String decorate(Object columnValue)方法。此方法同样接受一个Object参数，
  此参数就是对象的某个具体属性值，直接转化为对应类型，然后格式化，返回String。

 

9，建立动态链接。
 两种方式可以建立动态链接。
    第一种方式直接在页面上使用
  <display:column href="baseurl" paramId="paramid" />
  http://baseurl/paramid=columnvalue
  <display:column href="baseurl" paramId="paramid"  paramName=“name” paramScope="scope"/>
  http://baseurl/paramid=scope范围内的名字为name的值
  <display:column href="baseurl" paramId="paramid"  paramProperty=“propertyname”/>
  http://baseurl/paramid=名字为propertyname的属性值

 

 这种方式处理简单的链接十分有效，但是链接参数值如果通过查询数据库等比较复杂的方式得到的话，这种方式
 就不适应了。这时候就必须使用第二种方法。

 

 第二种方法，在装饰类中获得连接。
  装饰类多定义一些getXXX方法，那么页面上就可以使用<display:column propety="XXX" ..>来使用装饰类de
  getXXX方法。好，这样一来，在装饰类的getXXX方法里，得到此行对象，这样对象的各个属性就都能得到，
  之后去查数据库也好，去完成负责的判断逻辑也好，都很容易实现，别忘了，然后拼装起来，并写成一个
  <a href="....">这样的字符串返回。
  好，页面直接一句话就可得到此拼装的《a》了。<display:column propety="XXX" ..>

 

 第二种方法比较好些，因为可以显得更灵活。想怎么写就怎么写。第一种方法就是简单地实现。
 
10，翻页。
 1，怎么得到每行的序号？
  <display:table id="xxx" ...>
  使用<%=pageContext.getAttribute("xxx_rowNum")%>肯定好用。
   但是<c:out value="${row_rowNum}"/>这种方式就不好用。也不知道差哪了。

 

  翻页很简单。就是在<display:table  pagesize="m">这样来指定每页的数量就可以了。
  自动出现换页的索引，上下页等等东西。
  实在是方便。但是问题就是一次传下来很多东西，性能不好。等一会看看如何改良。

 

11，自动设置排序
  <display:table name="sessionScope.stest" defaultsort="1" defaultorder="descending">
  <display:column property="id" title="ID" sortable="true" headerClass="sortable" />
  可以设定默认时按照哪列排序，是升序还是降序。本例设置第一列默认时降序。
  每列都得对象都必须实现了Comparable接口才能被设置成sortable="true".
  如果没有实现Comparable，那么必须写一个装饰类。
  另外需要注意，
   他只对当前页面进行排序。而不是全部。在翻页时特别需要注意。
   要想实现全部的排序，那么必须重新写Action往网页传新的List了。

 

12，如何分组
  按照某列进行分组显示。
  这个功能真不错。
  <display:column property="city" title="CITY" group="1"/>
  <display:column property="project" title="PROJECT" group="2"/>
  这样不仅仅结果可以分组，而且还可以省略掉重复的数据，例如city列，project列都有
  A ，B ，A，B 两行那么第二行这两列就不显示了。

 

  同样只能对当前页进行分组。

 

  注意：第一列一定要1，第二列一定是2，否则出NUllPoint 错误。

 

13，统计
  好东西啊。可以对分组进行统计，也可以对所有行进行统计。
  主要靠TableDecorator类finishRow()返回统计结果，放到页面去显示。

 

  TableDecorator类方法getDecoratedObject()得到整个结果集。一般把它转化成List，因为大多数情况下结果
  是存放在List中的。
  public final String finishRow() {}当一行结束时执行此方法。所以用它来判断是否需要计算城市统计，
   抑或是全部统计。
  相当于事件处理。返回的字符串也将在页面上显示。本例返回了<tr><td>...</td><tr>这样的三份。
  这样就在表中嵌套进了三行。用来显示统计是足够了。

 

 

 

14，导出数据
  很简单。talbe里设置export=“true”就行了。配置文件也要设置好export.xml = true , 这样才能导出xml。
  类推pdf、excel、html、csv。
  每个列能配置是否在某种格式中显示，语法<display:column media="csv excel" 。。
  不配置就在所有格式中都显示。

 

  另外需要注意：
   被包含的文件不能使用这个功能，非要使用，就的用过滤器。以后再深研究吧。

 

15，配置DisplayTag.
  在应用的classpath路径上拷贝一个TableTag.properties,并命名为displaytag.properties.
  这样就默认取displaytag.properties里的配置了。想汉化，很简单。就需要把displaytag_zh.properties放到
  classpath路径下就可以了。

 

  标题像汉化：因为默认是jstl的资源文件使用方式。所以得先学习jstl的
  我知道了jstl.fmt如何使用资源文件。好了，jstl 首先必须用fmt:bunlle指定一个资源文件，然后才能
  在他的body部分使用此资源文件，颇麻烦。

 

  而displaytag呢？ 没有这么麻烦，如果与struts搭配使用，适用struts的资源文件当然最合理了。
  你必须在displaytag.properties里定义好一个
  参数，#locale.provider=org.displaytag.localization.I18nJstlAdapter
   locale.provider=org.displaytag.localization.I18nStrutsAdapter
  就这么简单，就能够使用struts配置文件了。我今天竟然看了一下午。哎，苦于没有好点的资料啊。

 

  问题是：如果不合struts搭配使用。如果仅仅在jstl环境下，displaytag又该如何使用jstl的资源文件呢？
  你必须象在jstl环境里一样使用<fmt:bundl>指定好资源文件，之后把displaytag标签放到他的body
  后，就可以使用jstl的资源文件了！！！！（幸亏我首先看了jstl使用资源文件的方法）

 

16,一个页面两个以上的表格.
  很简单,只需要每个表格配置不同的id.

 

17,表格里面还有表格.
  很简单.只要在外层表的
  <dispaly:column>
   ( 在这加<display:table ...>。。。
   </display:table>即可)
  </display：column>
 
  
  
18，表头表尾
  很简单：<dispaly:caption><display:footer>想<display:column>一样使用就行了.
  主要注意一下: <display:footer>内容必须是<tr>.....</tr>

 

19,表格里的值截断,与显示空白.
 <display:column property="nullValue" nulls="false"/>
   <display:column property="longDescription" maxLength="10" style="whitespace: nowrap;"/>
 简单得很.

 

ok，差不多到了关键的时候了。！！！！！

 

=============================================
关键:
20,如何分页.
 
 因为displaytag的分页机制需要一次把所有纪录都传到里面.所以对纪录很多的项目并不合适.如果还非得用
 displaytag那只好放弃他的一些功能了.比较理智的方法是仅仅让displaytag获得一页的list.这样就不用displaytag
 的分页index,而使用自己的,或者写customertag,或者使用jsppager tag.

 

 有很多人质疑这种方法,因为这使得displaytag的光芒至少减少了一半以上,因为他的很多功能因此而无法使用,
 例如排序功能,可以针对所有list进行全局排序,如果每次只传给一页的数据,全局排序就和当页排序没有区别了.
 displaytag的全局排序功能宣布废掉了.

 

 <display:table name="mylist" offset="m" length="n"/>这样的功能基本上也没有什么用处。

 

 那么还使用它干什么呢? displaytag即使废掉了一些武功仍然有它的优点.例如
 1,支持表格的嵌套.
 2,支持css这样就能写少量地代码使得程序更简洁.只好定义好一套css,就能全局范围内使用了.
 3,另外还支持截断长的字符串,这样就不用在页面使用自己的方法了. 
 4，能够实现比较复杂的逻辑从而产生动态链接。这也勉强所以个好处吧。
 5，能轻松地使用struts的资源文件。使得它可以很好的国际化。
 6，能够过滤空值。

 

 缺点： 
 1，分组就使用不了了，统计也无法使用了。只统计当前页是没有意义的。
 2，排序也变成当前页排序了。没多少意思。
 3，导出也变成当前页导出了，没多少意思了。