displaytag标签的使用手册

1.可以给它加上样式等，也可以定义显示的列
<display:table name="test" class="table" style="width:200px;" cellspacing="0" cellpadding="0">
<display:column property="id" title="ID" class="idcol"/>
<display:column property="name" />
<display:column property="description" title="Comments"/>
</display:table>

2.给它加个链接也很简单,下面的代码给name加了连接，并附带id参数
<display:column property="name" url="detail.jsp" paramId="id" paramProperty="id"/>

下面介绍几个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="name" sort="true"/>
</display:table>
      如果table有分页，Display Tag默认只对当前页进行排序，如果想对整个list排序，可以在display:table之间添加一段代码：
<display:setProperty name="sort.amount" value="list"/>

其实这种方式也不是很好，它是把所有记录一次性全查出来，浪费资源，而实际应用中，我们只要按照某种排序字段查询出本页显示的记录条数，所有可以采 用外部排序：
<display:table name="test" defaultorder="ascending" defaultsort="1" sort="external">
<display:column property="name" sort="true" sortName="name"/>
</display:table>
然后就要在Action中获取排序的字段，排序的方式，查询每页显示记录数。

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"，该列就可以被计算总数了。但这个功能有个缺点，不能用在有分页的时候，它只能合计第一页的数据。
注：目前我使用的是version="1.0" ，因此不支持这种写法。

三、表格显示样式的定义

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

六、显示部分数据

显示开始五条数据：通过设定length属性

<display:table name="test" length="5">
<display:column property="id" title="ID" />
<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="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>

八、使用装饰模式转换数据显示（写自己的 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，进行"修饰"

当然还有一种写法，就是不用直接构造实现类，如下：
request.setAttribute("dateDecorator", new com.telin.develop.displaytag.decorator.ColumnDecorator() {
public String decorate(Object columnValue) throws DecoratorException {
if (columnValue != null) {
   Date date = (Date) columnValue;
   return this.dateFormat.format(date);
}
return "";
}
});
<display:table name="test">
<display:column property="id" title="ID" />
<display:column property="email" />
<display:column property="status" />
<display:column property="date" decorator="dateDecorator" />//decorator的名字必须和request中设置的相同
</display:table>

九、创建动态连接

有两种方法创建动态连接：

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>

注意的是，当同时存在分页时排序仅仅针对的是当前页面，而不是整个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无效

操作参考：http://demo.raibledesigns.com/appfuse/demos/users-edit.jsp

十六.给出一个完整的实例:
<body>
<c:set var="checkAll">
   <input type="checkbox" name="all" id="all" onclick="javascript:checkall();" />
</c:set>

<form action="${ ctxPath }/core/duty.shtml" name="dutyForm" menthod="post">
   <input type="hidden" name="action" value="" />
    <div>
      <fmt:bundle basename="${coreResource}">
<display:table class="table" id="duty" decorator="dyndecorator" name="${resultList}" requestURI="${ ctxPath }/core/duty.shtml" export="false" partialList="true"
   size="${resultSize}" pagesize="${pageSize}" defaultorder="ascending" defaultsort="1" sort="external">
    <display:column headerClass="checkbox" title="${checkAll}">
       <input type="checkbox" id="itemChild" name="itemChild" value="${ duty.id }" />
    </display:column>
    <display:column style="width:200px;" property="name" titleKey="duty.name" group="1" sortable="true" headerClass="sortable" sortName="name" />
    <display:column property="remark" titleKey="duty.remark" maxLength="40" />
    <display:column style="width:150px;" property="intime" title="日期" maxLength="40" sortable="true" sortName="intime" decorator="dateDecorator" />
    <display:setProperty name="paging.banner.group_size" value="5" />
</display:table>
       </fmt:bundle>
    </div>

   <div>
<!-- 下面的 隐藏域 主要为了保存数据 -->
<input type="hidden" name="pageNo" value="${pageNo}" />
<input type="hidden" name="pageSize" value="${pageSize}" />
<input type="hidden" name="sortName" value="${sortName}" />
<input type="hidden" name="sortSequence" value="${sortSequence}" />
   </div>
</form>
</body>

注：这是一个带复选框的显示列表，常用属性有所涉及，下面的隐藏域主要是代码重写了源码的某些方法，需要跟踪记录一些显示条件。
列表如下。

如果有时间类型的数据，而你想把它转化为自己的格式的话，有两种方式：
1.写一个decorator，如：
public void pageDateRequest(HttpServletRequest request, String format) {
   final FastDateFormat dateFormat = FastDateFormat.getInstance(format);
   request.setAttribute("dateDecorator", new displaytag.decorator.ColumnDecorator() {//new后面是ColumnDecorator的完整类路径
    public String decorate(Object columnValue) throws DecoratorException {
     if (columnValue != null) {
      Date date = (Date) columnValue;
      return dateFormat.format(date);
     }
     return "";
    }
   });
}
然后在页面中调用。
2.用<fmt:formatDate />标签实现。
<display:column style="width:150px;" title="日期" sortable="true" sortName="intime">
<fmt:formatDate value="${duty.intime}" type="date" pattern="yyyy-MM-dd" />
</display:column>