DisplayTag详解

displaytag的官方网站http://displaytag.sourceforge.net。

1.DisplayTag标签库概述

（1）概述

DisplayTag是一个开源的自定义标签库（Custom Tag lib），他提供了直接而有效的格式化web视图层数据的有效手段。可以在web应用的MVC模式中集成DisplayTag到View层，其提供的强大表格格式化功能,用来处理jsp网页上的Table，可以对的Table进行分页、数据导出、分组、对列排序等等，能够大大减少代码量。

（2）常用标签

(1) <display:table></display: table > 

DisplayTag标签库中最重要最核心的标签，上面的标签都是嵌套在它里面来使用的。其核心作用是将给定的对象以html表格形式来显示，根据<display:column>标签格式化每一个项

(2)<display:column></display: column > 

显示表格中的一个行对象的一个属性。

(3)<display:footer></display: footer >      

嵌套在<display:table>标签中，在表格的最后一行数据之后显示的信息。

(4) <display:caption></display:caption>  

 它的作用相当于html页面的<title>标签。模仿的简单标记的html标题标记。 表标记中使用它来显示标题。

2.使用前的准备工作：

（1）添加所需的标签包

commons-beanutils.jar

commons-collection.jar

commons-lang.jar

displaytag.jar

displaytag-export-poi.jar

itext.jar

jstl.jar
standard.jar

（2）在web.xml下添加一个filter

    <filter>

        <filter-name>exportFilter</filter-name>

        <filter-class>org.displaytag.filter.ResponseOverrideFilter</filter-class>

    </filter>

（3）在jsp页面做一个引用：

<%@ taglib uri="http://displaytag.sf.net/el" prefix="display" %>

3. Display的常用功能：

（1）表格显示样式的定义

<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>

property对应List里对象的属性（用getXXX()方法取得），title则对应表格表头里的列名。定义列有两种方式：
　　A、<display:column property="email" />
　　使用<display:column/>标签里的property属性来定义
　　B、<display:column title="email">[e-mail]</display:column>
　　在<display:column/>标签体里增加内容，可以是常量，也可以用其他标签等等,用property属性来定义更加快速和利于排序

（2）标签取得数据的数据源

有四种范围：

pageScope
　　requestScope (默认)：<display:table name="test2" >
　　sessionScope：<display:table name="sessionScope.holder.list" > 注意，这里要指定范围，非默认
　　applicationScope

（3）通过增加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>

（4）分页

<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>

如果想对代码分页，只需在display:table标签中添加一项pagesize="每页显示行数"，如

<display:table name="test" pagesize="10"/>

（5）显示部分数据

显示开始五条数据：通过设定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>

（6）对列进行排序

    display tag可对列进行排序，就是点击列名，对该列的数据进行排序。你只需对想要排序的列添加 sort="true" 就OK，如下面的代码可对前三列进行排序。在display:table中添加defaultsort="列数"，可默认对指定的列排序。

   如果table有分页，Display Tag默认只对当前页进行排序，如果想对整个list排序，可以在display:table之间添加一段代码：

<display:setProperty name="sort.amount" value="list"/>

（7）导出数据

    在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"/>

（8）对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"来直接连接

（9）使用装饰模式转换数据显示

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);
　　}

（10）创建动态链接

有两种方法创建动态连接：
　　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>";
　　}

（11）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>

（12）统计

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

（13）表格中嵌套表格

<dispaly:column ><display:table  表格中的内容></display:table> </display：column>  

4. displaytag的翻页机制

 displaytag的翻页机制 这可能是displaytag的局限性了，它的翻页机制是这样的： 如果一个list中有10000个bean，按照它的机制，如果是第一页（每页n条），它会把前n条数据取出来，然后再把剩余的10000－n条删除，当你点击页面“2”的时候，它再从后台绕一圈，把第二页的数据，也就是把第n+1-2n条记录取出来，把剩余的删除。这样，它实现了翻页，又防止了内存占用过大。 但是，不管怎么说，它还是有一个取出所有条数的动作的，在极大数据量的情况下，有可能造成内存溢出。

5. Displaytag属性配置

前面所说的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进行转换。

6. 简单使用

    首先我们定义一个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>