Introducing iText's basic building blocks
许多编程教程都以Hello World示例开始。 本教程没有任何区别。
这是iText 7的HelloWorld示例:
PdfWriter writer = new PdfWriter(dest);
PdfDocument pdf = new PdfDocument(writer);
Document document = new Document(pdf);
document.add(new Paragraph("Hello World!"));
document.close();
让我们逐行检查这个例子:
我们创建一个PdfWriter实例。 PdfWriter是一个可以写PDF文件的对象。它对它正在编写的PDF文档的实际内容知之甚少。 PdfWriter不知道文件是关于什么的,它只是在文件结构完成时写入不同的文件部分和构成有效文档的不同对象。在这种情况下,我们传递一个名为dest的String参数,其中包含文件的路径,例如results / chapter01 / hello_world.pdf。构造函数也接受一个OutputStream作为参数。例如:如果我们想写一个Web应用程序,我们可以创建一个ServletOutputStream;如果我们想在内存中创建一个PDF文档,我们可以使用一个ByteArrayOutputStream;等等。
PdfWriter知道写什么,因为它听一个PdfDocument。 PdfDocument管理添加的内容,在不同的页面上分发内容,并跟踪与内容相关的任何信息。在第七章中,我们会发现PdfWriter可以听到各种各样的PdfDocument类。
一旦我们创建了一个PdfWriter和一个PdfDocument,我们就完成了所有底层的,PDF特定的代码。我们创建一个以PdfDocument为参数的Document。现在我们有了文档对象,我们可以忘记我们正在创建PDF。
我们创建一个包含文本“Hello World”的段落,并将该段落添加到文档对象中。
我们关闭文件。
图1为我们创建的Hello World PDF文件
让我们添加些难度。 让我们选择一个不同的字体,让我们组织一些文本作为一个列表; 见图1.2
RickAstley的例子显示了这是如何完成的:
PdfWriter writer = new PdfWriter(dest);
PdfDocument pdf = new PdfDocument(writer);
Document document = new Document(pdf);
// Create a PdfFont
PdfFont font = PdfFontFactory.createFont(FontConstants.TIMES_ROMAN);
// Add a Paragraph
document.add(new Paragraph("iText is:").setFont(font));
// Create a List
List list = new List()
.setSymbolIndent(12)
.setListSymbol("\u2022")
.setFont(font);
// Add ListItem objects
list.add(new ListItem("Never gonna give you up"))
.add(new ListItem("Never gonna let you down"))
.add(new ListItem("Never gonna run around and desert you"))
.add(new ListItem("Never gonna make you cry"))
.add(new ListItem("Never gonna say goodbye"))
.add(new ListItem("Never gonna tell a lie and hurt you"));
// Add the list
document.add(list);
document.close();
第1行到第3行和第22行与Hello World示例相同,但现在我们添加的不仅仅是一个段落。 iText总是使用Helvetica作为文本内容的默认字体。 如果你想改变这个,你必须创建一个PdfFont实例。 您可以通过从PdfFontFactory(第5行)获取字体来完成此操作。 我们使用这个字体对象来改变段落(第7行)和列表(第9行)的字体。 此列表是一个项目符号列表(第11行),列表项目由12个用户单位(第10行)缩进。 我们添加六个ListItem对象(14-19行)并将列表添加到文档中。
这很有趣,不是吗? 我们来介绍一些图片。 图1.3显示了如果我们将狐狸和狗的图像添加到段落,会发生什么情况。
如果我们从QuickBrownFox示例中删除样板代码,则保留以下几行:
Image fox = new Image(ImageDataFactory.create(FOX));
Image dog = new Image(ImageDataFactory.create(DOG));
Paragraph p = new Paragraph("The quick brown ")
.add(fox)
.add(" jumps over the lazy ")
.add(dog);
document.add(p);
我们将一个路径传递给一个ImageDataFactory,它将返回一个可以用来创建一个iText图像对象的对象。 ImageDataFactory的任务是检测传递的图像类型(jpg,png,gif。bmp,...)并对其进行处理,以便在PDF中使用。 在这种情况下,我们添加图像,使它们成为段落的一部分。 他们取代“狐狸”和“狗”。
Publishing a database
许多开发人员使用iText将数据库查询的结果发布到PDF文档。 假设我们有一个包含美国所有状态的数据库,并且我们想要创建一个PDF来列出这些状态以及表格中每个状态的一些信息,如图1.4所示。
使用真实的数据库可能会增加这些简单示例的复杂性,所以我们将使用CSV文件:united_states.csv(请参见图1.5)。
如果仔细看一下美国示例中的样板代码,就会发现我们对创建文档的行(第4行)做了一些小改动。 我们添加了一个额外的参数来定义文档中页面的大小。 默认页面大小为A4,默认情况下该页面是纵向使用的。 在这个例子中,我们也使用A4,但是我们旋转了页面(PageSize.A4.rotate()),使它在横向上使用,如图1.4所示。 我们也改变了利润率(第5行)。 默认情况下,iText使用36个用户单位(半英寸)的余量。 我们将所有的边缘改为20个用户单位(这个术语将在文中进一步解释)。
PdfWriter writer = new PdfWriter(dest);
PdfDocument pdf = new PdfDocument(writer);
Document document = new Document(pdf, PageSize.A4.rotate());
document.setMargins(20, 20, 20, 20);
PdfFont font = PdfFontFactory.createFont(FontConstants.HELVETICA);
PdfFont bold = PdfFontFactory.createFont(FontConstants.HELVETICA_BOLD);
Table table = new Table(new float[]{4, 1, 3, 4, 3, 3, 3, 3, 1});
table.setWidthPercent(100);
BufferedReader br = new BufferedReader(new FileReader(DATA));
String line = br.readLine();
process(table, line, bold, true);
while ((line = br.readLine()) != null) {
process(table, line, font, false);
}
br.close();
document.add(table);
document.close();
在这个例子中,我们一行一行地读取这个CSV文件,并且将CSV文件中存在的所有数据放在一个Table对象中。
我们首先创建两个同一族的PdfFont对象:Helvetica regular(第5行)和Helvetica bold(第6行)。我们创建一个Table对象,通过定义一个具有九个元素的浮点数组(第7行)来定义九个列。每个浮点数定义列的相对宽度。第一栏是第二栏的四倍;第三栏是第二栏的三倍;等等。我们还定义了相对于页面可用宽度的表格宽度(第8行)。在这种情况下,表格将使用页面宽度的100%减去页边距。
然后我们开始读取其路径存储在DATA常量(第9行)中的CSV文件。我们读取第一行以获得列标题(第10行),我们处理该行(第11行)。我们编写了一个process()方法,使用特定的字体将行添加到表中,并定义行是否包含标题行的内容。
public void process(Table table, String line, PdfFont font, boolean isHeader) {
StringTokenizer tokenizer = new StringTokenizer(line, ";");
while (tokenizer.hasMoreTokens()) {
if (isHeader) {
table.addHeaderCell(
new Cell().add(
new Paragraph(tokenizer.nextToken()).setFont(font)));
} else {
table.addCell(
new Cell().add(
new Paragraph(tokenizer.nextToken()).setFont(font)));
}
}
}
我们使用StringTokenizer来循环存储在我们的CSV文件的每一行中的所有字段。我们用特定的字体创建一个段落。我们将该段落添加到新的Cell对象。根据我们是否处理标题行,我们将这个Cell作为标题单元或普通单元添加到表中。
处理好标题行(第11行)后,我们循环其余行(第12行),并处理其余行(第13行)。如图1.4所示,表格不适合单个页面。没有必要担心:iText会根据需要创建尽可能多的新页面,直到完成表格呈现。 iText也将重复标题行,因为我们使用addCell()方法使用addHeaderCell()方法insead添加了该行的单元格。
一旦我们读完数据(第14行),我们将该表添加到文档(第16行),然后关闭它(第17行)。我们已经成功将我们的CSV文件发布为PDF格式。
那很简单。只有有限的几行代码,我们已经在PDF中创建了一个不错的表格。
Summary
仅举几个例子,我们已经看到了iText的强大功能。我们发现,以编程方式创建文档非常简单。在第一章中,我们讨论了高级对象,如段落,列表,图片,表格和单元格,这些是iText的基本构建块。
但是,有时需要使用较低级别的语法来创建PDF。 iText通过低级API实现了这一点。我们将在第二章中看一些使用这些低级方法的例子。