codecamp

14.BDF2-EXPORT

功能介绍

bdf2-export模块主要提供了对Dorado7中Datagrid和Autoform两种类型的控件报表导出功能,以Datagrid或者Autoform为显示模板,导出其数据为PDF或者Excel格式,支持Datagrid控件中filterBar数据过滤导出、列头组合自定义、数据自定义导出等功能。同时可以利用BDF2中提供的swf-viewer模块,在线浏览产生的报表文件,供用户在线浏览和打印使用。

环境配置

  • Maven Project (推荐)
如果您采用Maven管理项目,可以通过访问在线创建BDF2项目向导,在模块选择中勾选bdf2-export模块,动态创建一个MavenProject即可。或者在现有的BDF2Maven项目中,将bdf2-export模块的依赖信息添加到pom.xml文件当中,依赖配置如下:
bdf2-export依赖信息
<dependency>
 <groupId>com.bstek.bdf2</groupId>
 <artifactId>bdf2-export</artifactId>
 <version>2.0.0</version>
</dependency>
  • Dynamic Web Project
如果您打算采用Dynamic Web Project方式,那么访问在线创建BDF2项目向导,在项目类型中选择Dynamic Web Project,在模块选择中勾选bdf2-export模块,动态创建一个Dynamic Web Project即可,在这个动态创建的项目中包含了bdf2-export模块的jar包和第三方依赖包。
由于bdf2-export模块采用Dorado7组件方式实现导出、预览功能,那么在创建配置完成项目后,需要启动项目工程更新Dorado7配置规则(在线更新),更新完Dorado7配置规则后,打开DoradoView文件,可以看到在Dorado7工具栏新添加了一个组件Export2ReportAction。如下图所示:

Export2ReportAction控件
Export2ReportAction控件提供了若干属性配置,其中关键属性如下表所示:
属性名
类型
默认值
描述
templateString
导出数据模板DataGrid或者AutoForm的控件id,如果有多个值那么逗号分隔,例如 autoForm1,dataGrid1
interceptorNameString服务端数据拦截器名称
rowSpace
int
1报表间距,template属性指定多个控件id时有效
autoDownloadbooleantrue是否自动下载
showTitlebooleanfalse是否显示标题
titleNameString标题的名称
titleBgColorString#FFFFFF标题背景色
titleFontColorString#000000标题颜色
titleFontSizeint18标题字体大小
showPageNumberbooleantrue是否显示页号,导出pdf格式时有效
headerBgColorString#D8D8D8表头背景色
headerFontColorString#000000表头颜色
headerFontSizeint10表头字体大小
dataBgColorString#FFFFFF数据背景色
dataFontColorString#000000数据颜色
dataFontSizeint10数据字体大小
dataScopeStringcurrentPage数据范围,可选值currentPage、serverAll
maxSizeint1000导出数据最大记录数
fileNameString导出报表文件名称
extensionStringxls导出报表类型,可选值xls、xlsx、pdf,如果导出的excel数据量比较大,建议配置成xlsx格式
除了以上关键属性外,Export2ReportAction还提供一个关键事件,可以利用此事件自定义客户端数据的导出,如下表所示,
事件名称事件描述
onGetExportData(self,arg)
客户端获取导出的数据时触发,
arg.id 导出模板控件id
arg.data 导出的数据

功能演示

  • 导出DataGrid
如下图所示,对DataGrid控件数据做服务端导出,其中dataGrid控件id为dataGrid1:

在view上添加Export2ReportAction控件,设置其属性template为dataGrid1,dataScope为serverAll,showTitle为true,titleName为注册用户,导出效果如下:

默认导出是excel文件,如果设置属性extension为pdf,则导出的是pdf文件,导出pdf效果如下:
如果设置属性template为多个DataGrid控件id,并以逗号分隔表示,则可以导出多张表格数据 ,导出的excel文件效果如下图所示:
导出的pdf文件效果如下图所示:
  • 导出AutoForm
如下图所示,对AutoForm控件数据做导出,其中AutoForm控件id为autoForm1:
在Export2ReportAction控件上设置其属性template为autoForm1 ,则默认的导出效果如下图所示:
如果设置属性extension为pdf,导出pdf效果如下:

  • 在线预览
在线预览打印用到bdf2-swfviewe模块,相关配置可参考16.BDF2-SWFVIEWER
在view中添加一个dialog控件,设置id属性为dialogSwfViewer,在dialog上添加一个swfViewer控件,设置id属性为swfViewerTest,宽度和高度分别为100%,调用代码如下所示:
var action=view.get("#export2ReportAction1");
var dialog=view.get("#dialogSwfViewer");
//在服务端生成文件
action.set("autoDownload",false);
//文件类型为pdf
action.set("extension","pdf");
action.execute(function(result){
 dialog.show();
 var swfViewer=view.get("#swfViewerTest");
 //result包含文件id和name信息
 swfViewer.set("parameter",result);
 //export.pdf2swf 为内置的处理器
 swfViewer.set("handlerName","export.pdf2swf");
 swfViewer.refreshSwf();
});
在线预览效果如下图所示:
  • 客户端数据自定义拦截
设置属性dataScope为currentPage,在事件onGetExportData上定义待导出的excel数据,例如导出DataGrid中用户勾选的数据,代码如下所示:
var grid=view.id(arg.id);
if(grid instanceof dorado.widget.DataGrid){
 //获取表格中勾选的数据
 arg.data=grid.get("selection");
}
  • 服务端数据自定义拦截
如果需要对服务端导出的数据做拦截,则需要写一个实现com.bstek.bdf2.export.interceptor.IDataInterceptor接口的类,并配置的spring上下文环境中,然后指定Export2ReportAction控件的属性interceptorName值为实现类中getName()方法返回的名称。

例如对上面示例中的DataGrid控件列“是否是管理员”、“是否可用”做中文格式化处理,同时动态在服务端添加一条导出记录,则实现类定义如下所示:
package com.test;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.stereotype.Component;
import com.bstek.bdf2.export.interceptor.IDataInterceptor;
@Component
public class UserReportDataInterceptor implements IDataInterceptor {
 public String getName() {
 return "userReportDataInterceptor";
 }
 public String getDesc() {
 return "服务端表格数据拦截自定义演示";
 }
 public void interceptGridData(List<Map<String, Object>> list)
 throws Exception {
 for (Map<String, Object> user : list) {
 if (user.get("administrator") != null) {
 user.put("administrator",((Boolean) user.get("administrator")) == true ? "是": "否");
 }
 if (user.get("enabled") != null) {
 user.put("enabled",((Boolean) user.get("enabled")) == true ? "是" : "否");
 }
 }
 Map<String, Object> insertUser=new HashMap<String, Object>();
 insertUser.put("username", "user4");
 insertUser.put("cname", "user4");
 insertUser.put("ename", "user4");
 list.add(insertUser);
 }
 public void interceptAutoFormData(List<Map<String, Object>> list)
 throws Exception {
 }
}
同时,在Export2ReportAction控件中指定属性interceptorName为userReportDataInterceptor,导出显示效果如下图所示,

13.BDF2-COMPONENTPROFILE
15.BDF2-IMPORT
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }