报告样式
JasperReports 具有一项功能 <style>,可帮助控制报告模板中的文本属性。此元素是报告级别声明的样式设置的集合。前景色、背景色、字体是粗体、斜体还是普通、字体大小、字体边框等属性以及许多其他属性均由 <style> 元素控制。样式可以扩展其他样式,也可以添加或覆盖父样式的属性。
样式属性
<style> 元素具有许多属性。下表列出了一些最常用的属性 −
S.NO | 属性和说明 |
---|---|
1 | name 必填。它必须是唯一的,因为它在整个报告中引用相应的报告样式。 |
2 | isDefault 指示此样式是否是文档的默认样式。 |
3 | style 是对父样式的引用。 |
4 | mode 指定元素的透明度。可能的值是 Opaque 和 Transparent。 |
5 | forecolor 是对象的前景色。 |
6 | backcolor 是对象的背景色。 |
7 | fill 确定用于填充对象的填充图案。目前,允许的单个值为 Solid。 |
6 | radius 指定矩形角圆弧的半径。 |
7 | scaleImage 仅指定图像的比例。可能的值:Clip、FillFrame、RetainShape、RealHeight 和 RealSize。 |
8 | hAlign 指定水平对齐。可能的值:Left, Center, Right, 和 Justified。 |
9 | vAlign 指定垂直对齐。可能的值:Top, Middle, 和 Bottom。 |
10 | rotation 指定元素的旋转。可能的值:无、左、右和上下颠倒。 |
11 | lineSpacing 指定文本行之间的行距。可能的值:Single、1_1_2、Double。 |
12 | markup 指定样式文本的标记样式。 |
13 | fontName 指定字体名称。 |
14 | fontSize 指定字体大小。 |
15 | isBold 指示字体样式是否粗体。 |
16 | isItalic 表示字体样式是否为斜体。 |
17 | isUnderline 表示字体样式是否为下划线。 |
18 | isStrikeThrough 表示字体样式是否为删除线。 |
19 | pdfFontName 指定相关的 PDF 字体名称。 |
20 | pdfEncoding 指定 PDF 输出格式的字符编码。 |
22 | isPdfEmbedded 指示 PDF 字体是否嵌入。 |
23 | pattern 指定格式化文本的格式模式。 |
24 | isBlankWhenNull 表示如果表达式计算结果为空,是否应显示空字符串(空格)。 |
条件样式
在某些情况下,仅当满足某些条件时才应应用样式(例如,在报告详细信息部分中交替相邻行的颜色)。这可以使用条件样式来实现。
条件样式有两个元素 −
- 布尔条件表达式
- 样式
仅当条件评估为 true 时才使用样式。
将样式应用于报告元素
任何类型的报告元素都可以使用样式属性引用报告样式定义。因此,样式定义声明的所有适用于当前元素的样式属性都将被继承。要覆盖继承的值,可以使用在报告元素级别指定的样式属性。
样式模板
我们可以通过在公共位置定义样式来制作一组具有通用外观的报告。然后,报告模板可以引用此通用样式模板。样式模板是一个包含一个或多个样式定义的 XML 文件。样式模板文件通常使用 *.jrtx 扩展名,但这不是强制性的。
样式模板包含以下元素 −
<jasperTemplate> − 这是样式模板文件的根元素。
<template> − 此元素用于包含对其他模板文件的引用。此元素的内容被解释为所引用模板文件的位置。
<style> − 此元素与报告设计模板(JRXML 文件)中同名的元素相同,不同之处在于样式模板中的样式不能包含条件样式。此限制是由于条件样式涉及报告表达式,而表达式只能在单个报告定义的上下文中进行解释。
对样式模板的引用作为 <template> 元素包含在 JRXML 报告中。样式模板在报告填充时加载,样式名称引用在加载所有模板后解析。在加载样式模板并将样式名称解析为样式时,将创建样式模板的树/图,树的顶部是报告中定义的样式集。在此树上,样式名称引用被解析为深度优先遍历中与名称匹配的最后一个样式。
示例
让我们尝试条件样式和样式模板。让我们将 <style> 元素 alternateStyle 添加到我们现有的报告模板(报告设计 章)。根据条件,字体颜色变为蓝色以表示偶数计数。我们还包含了一个样式模板 "styles.jrtx"。修订后的报告模板 (jasper_report_template.jrxml) 如下。将其保存到 C:\tools\jasperreports-5.0.1\test 目录 −
<?xml version = "1.0"?> <!DOCTYPE jasperReport PUBLIC "//JasperReports//DTD Report Design//EN" "http://jasperreports.sourceforge.net/dtds/jasperreport.dtd"> <jasperReport xmlns = "http://jasperreports.sourceforge.net/jasperreports" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://jasperreports.sourceforge.net/jasperreports http://jasperreports.sourceforge.net/xsd/jasperreport.xsd" name = "jasper_report_template" pageWidth = "595" pageHeight = "842" columnWidth = "515" leftMargin = "40" rightMargin = "40" topMargin = "50" bottomMargin = "50"> <template>"styles.jrtx"</template> <style name = "alternateStyle" fontName = "Arial" forecolor = "red"> <conditionalStyle> <conditionExpression> <![CDATA[new Boolean($V{countNumber}.intValue() % 2 == 0)]]> </conditionExpression> <style forecolor = "blue" isBold = "true"/> </conditionalStyle> </style> <parameter name = "ReportTitle" class = "java.lang.String"/> <parameter name = "Author" class = "java.lang.String"/> <queryString> <![CDATA[]]> </queryString> <field name = "country" class = "java.lang.String"> <fieldDescription><![CDATA[country]]></fieldDescription> </field> <field name = "name" class = "java.lang.String"> <fieldDescription><![CDATA[name]]></fieldDescription> </field> <variable name = "countNumber" class = "java.lang.Integer" calculation = "Count"> <variableExpression><![CDATA[Boolean.TRUE]]></variableExpression> </variable> <title> <band height = "70"> <line> <reportElement x = "0" y = "0" width = "515" height = "1"/> </line> <textField isBlankWhenNull = "true" bookmarkLevel = "1"> <reportElement x = "0" y = "10" width = "515" height = "30"/> <textElement textAlignment = "Center"> <font size = "22"/> </textElement> <textFieldExpression class = "java.lang.String"> <![CDATA[$P{ReportTitle}]]> </textFieldExpression> <anchorNameExpression><![CDATA["Title"]]></anchorNameExpression> </textField> <textField isBlankWhenNull = "true"> <reportElement x = "0" y = "40" width = "515" height = "20"/> <textElement textAlignment = "Center"> <font size = "10"/> </textElement> <textFieldExpression class = "java.lang.String"> <![CDATA[$P{Author}]]> </textFieldExpression> </textField> </band> </title> <columnHeader> <band height = "23"> <staticText> <reportElement mode = "Opaque" x = "0" y = "3" width = "535" height = "15" backcolor = "#70A9A9" /> <box> <bottomPen lineWidth = "1.0" lineColor = "#CCCCCC" /> </box> <textElement /> <text> <![CDATA[]]> </text> </staticText> <staticText> <reportElement x = "414" y = "3" width = "121" height = "15" /> <textElement textAlignment = "Center" verticalAlignment = "Middle"> <font isBold = "true" /> </textElement> <text><![CDATA[Country]]></text> </staticText> <staticText> <reportElement x = "0" y = "3" width = "136" height = "15" /> <textElement textAlignment = "Center" verticalAlignment = "Middle"> <font isBold = "true" /> </textElement> <text><![CDATA[Name]]></text> </staticText> </band> </columnHeader> <detail> <band height = "16"> <staticText> <reportElement mode = "Opaque" x = "0" y = "0" width = "535" height = "14" backcolor = "#E5ECF9" /> <box> <bottomPen lineWidth = "0.25" lineColor = "#CCCCCC" /> </box> <textElement /> <text> <![CDATA[]]> </text> </staticText> <textField> <reportElement style = "alternateStyle" x = "414" y = "0" width = "121" height = "15" /> <textElement textAlignment = "Center" verticalAlignment = "Middle"> <font size = "9" /> </textElement> <textFieldExpression class = "java.lang.String"> <![CDATA[$F{country}]]> </textFieldExpression> </textField> <textField> <reportElement x = "0" y = "0" width = "136" height = "15" style = "Strong"/> <textElement textAlignment = "Center" verticalAlignment = "Middle" /> <textFieldExpression class = "java.lang.String"> <![CDATA[$F{name}]]> </textFieldExpression> </textField> </band> </detail> </jasperReport>
样式模板styles.jrtx内容如下,保存至C:\tools\jasperreports-5.0.1\test目录下。
<?xml version = "1.0"?> <!DOCTYPE jasperTemplate PUBLIC "-//JasperReports//DTD Template//EN" "http://jasperreports.sourceforge.net/dtds/jaspertemplate.dtd"> <jasperTemplate> <style name = "Strong" isBold = "true" pdfFontName = "Helvetica-Bold" backcolor = "lightGray forecolor = "green"/> </jasperTemplate>
报告填充的 java 代码保持不变。文件 C:\tools\jasperreports-5.0.1\test\src\com.tutorialspoint\JasperReportFill.java 的内容如下 −
package com.tutorialspoint; import java.util.ArrayList; import java.util.HashMap; import java.util.Map; import net.sf.jasperreports.engine.JRException; import net.sf.jasperreports.engine.JasperFillManager; import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource; public class JasperReportFill { @SuppressWarnings("unchecked") public static void main(String[] args) { String sourceFileName = "C://tools/jasperreports-5.0.1/test/jasper_report_template.jasper"; DataBeanList DataBeanList = new DataBeanList(); ArrayList<DataBean> dataList = DataBeanList.getDataBeanList(); JRBeanCollectionDataSource beanColDataSource = new JRBeanCollectionDataSource(dataList); Map parameters = new HashMap(); /** * Passing ReportTitle and Author as parameters */ parameters.put("ReportTitle", "List of Contacts"); parameters.put("Author", "Prepared By Manisha"); try { JasperFillManager.fillReportToFile( sourceFileName, parameters, beanColDataSource); } catch (JRException e) { e.printStackTrace(); } } }
POJO 文件 C:\tools\jasperreports-5.0.1\test\src\com.tutorialspoint\DataBean.java 的内容如下 −
package com.tutorialspoint; public class DataBean { private String name; private String country; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getCountry() { return country; } public void setCountry(String country) { this.country = country; } }
文件 C:\tools\jasperreports-5.0.1\test\src\com.tutorialspoint\DataBeanList.java 的内容如下 −
package com.tutorialspoint; import java.util.ArrayList; public class DataBeanList { public ArrayList<DataBean> getDataBeanList() { ArrayList<DataBean> dataBeanList = new ArrayList<DataBean>(); dataBeanList.add(produce("Manisha", "India")); dataBeanList.add(produce("Dennis Ritchie", "USA")); dataBeanList.add(produce("V.Anand", "India")); dataBeanList.add(produce("Shrinath", "California")); return dataBeanList; } /** * This method returns a DataBean object, * with name and country set in it. */ private DataBean produce(String name, String country) { DataBean dataBean = new DataBean(); dataBean.setName(name); dataBean.setCountry(country); return dataBean; } }
报告生成
我们将使用常规 ANT 构建过程编译并执行上述文件。文件 build.xml(保存在目录 C:\tools\jasperreports-5.0.1\test 下)的内容如下所示。
导入文件 - baseBuild.xml 取自环境设置一章,应放置在与 build.xml 相同的目录中。
<?xml version = "1.0" encoding = "UTF-8"?> <project name = "JasperReportTest" default = "viewFillReport" basedir = "."> <import file = "baseBuild.xml" /> <target name = "viewFillReport" depends = "compile,compilereportdesing,run" description = "Launches the report viewer to preview the report stored in the .JRprint file."> <java classname = "net.sf.jasperreports.view.JasperViewer" fork = "true"> <arg value = "-F${file.name}.JRprint" /> <classpath refid = "classpath" /> </java> </target> <target name = "compilereportdesing" description = "Compiles the JXML file and produces the .jasper file."> <taskdef name = "jrc" classname = "net.sf.jasperreports.ant.JRAntCompileTask"> <classpath refid = "classpath" /> </taskdef> <jrc destdir = "."> <src> <fileset dir = "."> <include name = "*.jrxml" /> </fileset> </src> <classpath refid = "classpath" /> </jrc> </target> </project>
接下来,让我们打开命令行窗口并转到放置 build.xml 的目录。最后,执行命令 ant -Dmain-class=com.tutorialspoint.JasperReportFill(viewFullReport 是默认目标),如下所示 −
C:\tools\jasperreports-5.0.1\test>ant -Dmain-class=com.tutorialspoint.JasperReportFill Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml clean-sample: [delete] Deleting directory C:\tools\jasperreports-5.0.1\test\classes [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jasper [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrprint compile: [mkdir] Created dir: C:\tools\jasperreports-5.0.1\test\classes [javac] C:\tools\jasperreports-5.0.1\test\baseBuild.xml:28: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds [javac] Compiling 3 source files to C:\tools\jasperreports-5.0.1\test\classes compilereportdesing: [jrc] Compiling 1 report design files. [jrc] log4j:WARN No appenders could be found for logger (net.sf.jasperreports.engine.xml.JRXmlDigesterFactory). [jrc] log4j:WARN Please initialize the log4j system properly. [jrc] log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info. [jrc] File : C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrxml ... OK. run: [echo] Runnin class : com.tutorialspoint.JasperReportFill [java] log4j:WARN No appenders could be found for logger (net.sf.jasperreports.extensions.ExtensionsEnvironment). [java] log4j:WARN Please initialize the log4j system properly. viewFillReport: [java] log4j:WARN No appenders could be found for logger (net.sf.jasperreports.extensions.ExtensionsEnvironment). [java] log4j:WARN Please initialize the log4j system properly.
上述编译的结果是,打开了一个 JasperViewer 窗口,如下图所示 −
在这里,我们可以看到,对于偶数计数(在国家/地区列中),字体颜色更改为蓝色。在列名称中,字体颜色更改为绿色(此样式是从样式模板中引用的)。