报表参数界面API

顶( )

最后更新日期：

有人发表评论 (点击查看)

实现原理

读取报表参数属性ReportParameterAttr
是否显示参数界面
参数界面的布局
参数界面的显示位置
弹出窗口标题
是否延迟报表展示
添加参数至参数窗口
设置参数界面背景
重新设置参数属性

具体实例

在设计器中可以通过对参数界面的设计来控制参数的显示形式，如参数界面的布局、背景、显示方式等。那如何在程序中控制参数的相关属性呢？FineReport中通过ReportParameterAttr类来实现。以下具体介绍该类的使用方法，实现效果如下：

1. 实现原理

1.1 读取报表参数属性ReportParameterAttr

若我们已经读取了一个模板并将其保存为WorkBook对象，如下

//读取模板保存为WorkBook对象

我们就可以读取该WorkBook对象的参数属性，从而控制报表参数属性了。

//获取WorkBook工作薄的参数属性ReportParameterAttr

ReportParameterAttr paraAttr = workbook.getReportParameterAttr();

1.2 是否显示参数界面

* 是否显示参数界面

* null : 不显示参数界面

* parameterUI对象 : 显示定义的参数界面

paraAttr.setParameterUI(null);

1.3 参数界面的布局

* 参数界面的布局

* 0 : 靠左

* 1 ：居中

* 2 ：靠右

paraAttr.setAlign(2);

1.4 参数界面的显示位置

* 参数界面的显示位置

* 0/ReportParameterAttr.POPUP : 弹出显示

* 1/ReportParameterAttr.EMBED : 内嵌显示

paraAttr.setWindowPosition(ReportParameterAttr.POPUP);

1.5 弹出窗口标题

* 若参数界面选择弹出显示，则可以设置弹出的参数窗口标题

* String title

paraAttr.setParameterWindowTitle("参数属性parameterAttr的使用");

1.6 是否延迟报表展示

* 是否延迟报表展示

* true : 延迟报表展示

* false : 不延迟报表展示

paraAttr.setDelayPlaying(true);

1.7 添加参数至参数窗口

* 定义参数变量并添加参数至参数窗口中

Parameter para2 = new Parameter("time","2010-01-01");

paraAttr.addParameter(para2);

注意：addParameter是把新定义的参数变量添加入参数窗口，不会自动添加至参数界面，需要定义参数界面才可以将参数放入参数界面，如下图效果

1.8 设置参数界面背景

* 设置参数界面背景

* ColorBackground ：颜色背景

* GradientBackground ：渐变色背景

* ImageBackground ：图片背景

* PatternBackground ：图案背景

* TextureBackground ：纹理背景

Background background = ColorBackground.getInstance(new Color(0,255,255));

paraAttr.setBackground(background);

1.9 重新设置参数属性

改变了一系列参数属性后，需要将改变后的ReportParameterAttr重新添加至WorkBook中

//重新设置参数属性

workbook.setReportParameterAttr(paraAttr);

2. 具体实例

如我们将Parameter.cpt模板的参数界面改为弹出式的，并设置参数窗口标题为“参数属性parameterAttr的使用”，完整代码如下：

package com.fr.io;

import java.io.File;
import java.io.FileOutputStream;

import com.fr.base.FRContext;
import com.fr.base.ModuleContext;
import com.fr.report.parameter.ReportParameterAttr;
import com.fr.report.EngineModule;
import com.fr.report.WorkBook;
import com.fr.report.io.TemplateExporter;
import com.fr.report.io.TemplateImporter;
import com.fr.web.dav.LocalEnv;

public class SetParameterWindow {
	public static void main(String[] args) {
		try {
			// 定义报表运行环境,用于执行报表
			String envpath = "E:\\FineReport_6.5\\WebReport\\WEB-INF";
			FRContext.setCurrentEnv(new LocalEnv(envpath));
			ModuleContext.startModule(EngineModule.class.getName(), null);
			// 读取模板保存为WorkBook对象
			File cptfile = new File(
					"D:\\FineReport_6.5\\WebReport\\WEB-INF\\reportlets\\doc\\Primary\\Parameter\\Parameter.cpt");
			TemplateImporter tplimp = new TemplateImporter();
			WorkBook workbook = tplimp.generateWorkBook(cptfile);
			// 获取WorkBook工作薄的参数属性ReportParameterAttr
			ReportParameterAttr paraAttr = workbook.getReportParameterAttr();
			/*
			 * 参数界面的显示位置 0/ReportParameterAttr.POPUP : 弹出显示
			 * 1/ReportParameterAttr.EMBED : 内嵌显示
			 */
			paraAttr.setWindowPosition(ReportParameterAttr.POPUP);
			/*
			 * 若参数界面选择弹出显示，则可以设置弹出的参数窗口标题 String title
			 */
			paraAttr.setParameterWindowTitle("参数属性parameterAttr的使用");
			// 重新设置参数属性,导出最终结果
			workbook.setReportParameterAttr(paraAttr);
			FileOutputStream outputStream = new FileOutputStream(new File(
					"D:\\newParameter.cpt"));
			TemplateExporter templateExporter = new TemplateExporter();
			templateExporter.export(outputStream, workbook);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

执行程序，将在D盘生成新的cpt模板，打开生成的模板|参数设计界面，可以看到，参数显示样式已经变为弹出式了，参数标题也转为我们程序中设置的值。

如果需要设置其他属性您可以使用该程序试验其他属性的设置效果。

文明发言，用心评论

		应用此篇文章，您: 不费力研究了一会琢磨了好久

查看全部条>>	<<只显示5条

返回顶部