历史版本30 :报表参数界面API 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1.描述编辑

在设计器中可以通过对参数界面的设计来控制参数的显示形式，如参数界面的布局、背景、显示方式等。那如何在程序中控制参数的相关属性呢？

FineReport中通过ReportParameterAttr类来实现。以下具体介绍该类的使用方法，比如需要通过程序实现参数界面背景色为绿色，并且居中显示，在BS端预览实现效果如下：

222

2. 实现原理编辑

2.1 读取报表参数属性ReportParameterAttr
若我们已经读取了一个模板并将其保存为WorkBook对象，如下

1）读取模板保存为WorkBook对象

WorkBook workbook = (WorkBook) TemplateWorkBookIO .readTemplateWorkBook(FRContext.getCurrentEnv(), "\\doc\\Primary\\Parameter\\Parameter.cpt");
我们就可以读取该WorkBook对象的参数属性，从而控制报表参数属性了。
2）获取WorkBook工作薄的参数属性ReportParameterAttr
ReportParameterAttr paraAttr = workbook.getReportParameterAttr();
1.2 是否显示参数界面
/*
* 是否显示参数界面
* null : 不显示参数界面
* parameterUI对象 : 显示定义的参数界面
*/
paraAttr.setParameterUI(null);
1.3 参数界面的布局
/*
* 参数界面的布局
* 0 : 靠左
* 1 ：居中
* 2 ： 靠右
*/
paraAttr.setAlign(2);
1.4 是否延迟报表展示
/*
* 是否延迟报表展示
* true : 延迟报表展示
* false : 不延迟报表展示
*/
paraAttr.setDelayPlaying(true);
1.5 添加参数至参数窗口
/*
* 定义参数变量并添加参数至参数窗口中
*/
Parameter para2 = new Parameter("time","2010-01-01");paraAttr.addParameter(para2);
注：addParameter是把新定义的参数变量添加入参数窗口，不会自动添加至参数界面，需要定义参数界面才可以将参数放入参数界面，如下图效果
222
1.6 设置参数界面背景
/*
* 设置参数界面背景
* ColorBackground ：颜色背景
* GradientBackground ：渐变色背景
* ImageBackground ：图片背景
* PatternBackground ：图案背景
* TextureBackground ：纹理背景
*/
Background background = ColorBackground.getInstance(new Color(0,255,255));paraAttr.setBackground(background);
1.7 重新设置参数属性
改变了一系列参数属性后，需要将改变后的ReportParameterAttr重新添加至WorkBook中
//重新设置参数属性
workbook.setReportParameterAttr(paraAttr);

2. 具体实例编辑

如我们将Parameter.cpt模板的参数界面改为弹出式的，并设置参数窗口标题为“参数属性parameterAttr的使用”，完整代码如下：
package com.fr.io; import java.awt.Color; import java.io.File; import java.io.FileOutputStream; import com.fr.base.FRContext; import com.fr.general.ModuleContext; import com.fr.base.background.ColorBackground; import com.fr.dav.LocalEnv; import com.fr.general.Background; import com.fr.io.TemplateWorkBookIO; import com.fr.io.exporter.EmbeddedTableDataExporter; import com.fr.main.impl.WorkBook; import com.fr.main.parameter.ReportParameterAttr; import com.fr.report.module.EngineModule; public class SetParameterWindow { public static void main(String[] args) { try { // 定义报表运行环境,用于执行报表 String envPath = "D:\\FineReport\\develop\\code\\build\\package\\WebReport\\WEB-INF"; FRContext.setCurrentEnv(new LocalEnv(envPath)); ModuleContext.startModule(EngineModule.class.getName()); // 读取模板保存为WorkBook对象 WorkBook workbook = (WorkBook) TemplateWorkBookIO .readTemplateWorkBook(FRContext.getCurrentEnv(), "\\doc\\Primary\\Parameter\\Parameter.cpt"); // 获取WorkBook工作薄的参数属性ReportParameterAttr ReportParameterAttr paraAttr = workbook.getReportParameterAttr(); /* 参数界面的布局 * 0 : 靠左 * 1 ：居中 * 2 ： 靠右 */ paraAttr.setAlign(1); /* * 设置参数界面背景 * ColorBackground ：颜色背景 * GradientBackground ：渐变色背景 * ImageBackground ：图片背景 * PatternBackground ：图案背景 * TextureBackground ：纹理背景 */ Background background = ColorBackground.getInstance(new Color(0,255,255)); paraAttr.setBackground(background); // 重新设置参数属性,导出最终结果 workbook.setReportParameterAttr(paraAttr); FileOutputStream outputStream = new FileOutputStream(new File( "D:\\newParameter.cpt")); EmbeddedTableDataExporter templateExporter = new EmbeddedTableDataExporter(); templateExporter.export(outputStream, workbook); } catch (Exception e) { e.printStackTrace(); } } }
注：定义报表运行环境需要根据实际设计器的安装路径，比如安装在D盘，即 String envPath = "D:\\FineReport_8.0\\WebReport\\WEB-INF"
执行程序，将在D盘生成新的cpt模板，打开生成的模板，在浏览器端预览模板，就会看到如下图所示的效果。
222

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