首页 > 代码库 > IText入门必须要知道的东西
IText入门必须要知道的东西
一、Itext简介
iText是著名的开放源码的站点sourceforge一个项目,是用于生成PDF文档的一个java类库。通过iText不仅可以生成PDF或rtf的文档,而且可以将XML、Html文件转化为PDF文件。
iText的安装非常方便,在http://www.lowagie.com/iText/download.html网站上下载iText.jar文件后,只需要在系统的CLASSPATH中加入iText.jar的路径,在程序中就可以使用iText类库了。
二、生成PDF步骤
1、创建文档对象实例
Document document = new Document();
2、建立书写器(Writer)与文档对象(document)关联,通过书写器将文档写入磁盘
PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(DEST));
DEST:生成PDF文件
3、打开文档
document.open();
4、向文档中添加内容
document.add(new Paragraph("PDF demo"));
5、关闭文档
document.close();
三、具体分析
1、对象实例
public document();
public document(Rectangle pageSize);
public document(Rectangle pageSize, int marginLeft, int marginRight, int marginTop, int marginBottom);
pageSize是指文档页面大小,public document();页面大小为A4,效果等同于Document(PageSize.A4);
marginLeft、marginRight、marginTop、marginBottom分别为左、右、上、下的页边距。
通过参数pageSize可以设定页面大小、面背景色、以及页面横向/纵向等属性。iText定义了A0-A10、AL、LETTER、HALFLETTER、_11x17、LEDGER、NOTE、B0-B5、ARCH_A-ARCH_E、FLSA和FLSE等纸张类型,也可以通过Rectangle pageSize = new Rectangle(144, 720);自定义纸张。通过Rectangle方法rotate()可以将页面设置成横向。
2、书写器对象
一旦文档(document)对象建立好之后,需要建立一个或多个书写器(Writer)对象与之关联。通过书写器(Writer)对象可以将具体文档存盘成需要的格式。
PDFWriter可以将文档存成PDF文件;HtmlWriter可以将文档存成html文件
3、文档属性
在文档打开之前,可以设定文档的标题、主题、作者、关键字、装订方式、创建者、生产者、创建日期等属性,调用的方法分别是:
public boolean addTitle(String title)
public boolean addSubject(String subject)
public boolean addKeywords(String keywords)
public boolean addAuthor(String author)
public boolean addCreator(String creator)
public boolean addProducer()
public boolean addCreationDate()
public boolean addHeader(String name, String content)
其中方法addHeader对于PDF文档无效,addHeader仅对html文档有效,用于添加文档的头信息。
当新的页面产生之前,可以设定页面的大小、书签、脚注(HeaderFooter)等信息,调用的方法是:
public boolean setPageSize(Rectangle pageSize)
public boolean add(Watermark watermark)
public void removeWatermark()
public void setHeader(HeaderFooter header)
public void resetHeader()
public void setFooter(HeaderFooter footer)
public void resetFooter()
public void resetPageCount()
public void setPageCount(int pageN)
如果要设定第一面的页面属性,这些方法必须在文档打开前调用。
对于PDF文档,iText还提供了文档的显示属性,通过调用书写器的 setViewerPreferences方法可以控制文档打开时Acrobat Reader的显示属性,如是否单页显示、是否全屏显示、是否隐藏状态条等属性。
另外,iText也提供了对PDF文件的安全保护,通过书写器(Writer)的setEncryption方法,可以设定文档的用户口令、只读、可打印等属性。
4、添加文档内容
所有向文档添加的内容都是以对象为单位的,如Phrase、Paragraph、Table、Graphic对象等。比较常用的是段落(Paragraph)对象,用于向文档中添加一段文字。
IText中用文本块(Chunk)、短语(Phrase)和段落(paragraph)处理文本。文本块(Chunk)是处理文本的最小单位,有一串带格式(包括字体、颜色、大小)的字符串组成。如以下代码就是产生一个字体为HELVETICA、大小为10、带下划线的字符串:
Chunk chunk1 = new Chunk("This text is underlined", FontFactory.getFont(FontFactory.HELVETICA, 12, Font.UNDERLINE));
短语(Phrase)由一个或多个文本块(Chunk)组成,短语(Phrase)也可以设定字体,但对于其中以设定过字体的文本块(Chunk)无效。通过短语(Phrase)成员函数add可以将一个文本块(Chunk)加到短语(Phrase)中,如:phrase6.add(chunk);
段落(paragraph)由一个或多个文本块(Chunk)或短语(Phrase)组成,相当于WORD文档中的段落概念,同样可以设定段落的字体大小、颜色等属性。另外也可以设定段落的首行缩进、对齐方式(左对齐、右对齐、居中对齐)。通过函数setAlignment可以设定段落的对齐方式,setAlignment的参数1为居中对齐、2为右对齐、3为左对齐,默认为左对齐。
Itext中处理表格在有PDFTable,Table。对于简单在表格处理可以用Table,但如果要处理复杂的表格就需要PDFTable进行处理。
创建表格时,必须要指定列,行则不是必须的。
建立表格之后,可以设定表格的属性,如:边框宽度、边框颜色、衬距(padding space 即单元格之间的间距)大小等属性。
IText中处理图像的类为Image,目前iText支持的图像格式有:GIF, Jpeg, PNG, wmf等格式,对于不同的图像格式,iText用同样的构造函数自动识别图像格式。通过下面的代码分别获得gif、jpg、png图像的实例。
Image gif = Image.getInstance("vonnegut.gif"); Image jpeg = Image.getInstance("myKids.jpg"); Image png = Image.getInstance("hitchcock.png");
图像的位置
图像的位置主要是指图像在文档中的对齐方式、图像和文本的位置关系。IText中通过函数public void setAlignment(int alignment)进行处理,参数alignment为Image.RIGHT、Image.MIDDLE、Image.LEFT分别指右对齐、居中、左对齐;当参数alignment为Image.TEXTWRAP、Image.UNDERLYING分别指文字绕图形显示、图形作为文字的背景显示。这两种参数可以结合以达到预期的效果,如setAlignment(Image.RIGHT|Image.TEXTWRAP)显示的效果为图像右对齐,文字围绕图像显示。
图像的尺寸和旋转
如果图像在文档中不按原尺寸显示,可以通过下面的函数进行设定:
public void scaleAbsolute(int newWidth, int newHeight)
public void scalePercent(int percent)
public void scalePercent(int percentX, int percentY)
函数public void scaleAbsolute(int newWidth, int newHeight)直接设定显示尺寸;
函数public voidscalePercent(int percent)设定显示比例,如scalePercent(50)表示显示的大小为原尺寸的50%;
而函数scalePercent(int percentX, int percentY)则图像高宽的显示比例。
如果图像需要旋转一定角度之后在文档中显示,可以通过函数public void setRotation(double r)设定,参数r为弧度,如果旋转角度为30度,则参数r= Math.PI/6。
四、中文处理
默认的iText字体设置不支持中文字体,需要下载远东字体包iTextAsian.jar,否则不能往PDF文档中输出中文字体。通过下面的代码就可以在文档中使用中文了:
BaseFont bfChinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
或者
BaseFont bfChinese = BaseFont.createFont("C:/Windows/Fonts/simhei.ttf",BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);、
注意:此处大小写敏感!例如宋体的英文名称是SimSun(注意不是simsun!,首字母都是大写的)
错误写法:font-family:宋体 或者 font-family:simsun
正确写法:font-family:SimSun 或者 font-family:SimHei
确保上述所有字体均通过addFont加入,字体名称错误或者字体不存在会抛出异常,很方便,但是没导入的字体不会有任何提示。
五、例子
1、添加水印,并且增加权限
1 @Test 2 public void addWaterMark() throws Exception{ 3 String srcFile="D:\\work\\pdf\\win10.pdf";//要添加水印的文件 4 String text="系统集成公司";//要添加水印的内容 5 int textWidth=200; 6 int textHeight=440; 7 PdfReader reader = new PdfReader(srcFile);// 待加水印的文件 8 PdfStamper stamper = new PdfStamper(reader, new FileOutputStream(new File("D:\\work\\pdf\\addWaterMark.pdf")));// 加完水印的文件 9 // byte[] userPassword = "123".getBytes(); 10 byte[] ownerPassword = "12345".getBytes(); 11 // int permissions = PdfWriter.ALLOW_COPY|PdfWriter.ALLOW_MODIFY_CONTENTS|PdfWriter.ALLOW_PRINTING; 12 // stamper.setEncryption(null, ownerPassword, permissions,false); 13 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_ASSEMBLY, false); 14 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_COPY, false); 15 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_DEGRADED_PRINTING, false); 16 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_FILL_IN, false); 17 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_MODIFY_ANNOTATIONS, false); 18 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_MODIFY_CONTENTS, false); 19 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_PRINTING, false); 20 stamper.setEncryption(null, ownerPassword, PdfWriter.ALLOW_SCREENREADERS, false); 21 stamper.setEncryption(null, ownerPassword, PdfWriter.DO_NOT_ENCRYPT_METADATA, false); 22 stamper. setViewerPreferences(PdfWriter.HideToolbar|PdfWriter.HideMenubar); 23 // stamper.setViewerPreferences(PdfWriter.HideWindowUI); 24 int total = reader.getNumberOfPages() + 1; 25 PdfContentByte content; 26 BaseFont font = BaseFont.createFont("font/SIMKAI.TTF", BaseFont.IDENTITY_H, BaseFont.EMBEDDED); 27 for (int i = 1; i < total; i++)// 循环对每页插入水印 28 { 29 content = stamper.getUnderContent(i);// 水印的起始 30 content.beginText();// 开始 31 content.setColorFill(BaseColor.GREEN);// 设置颜色 默认为蓝色 32 content.setFontAndSize(font, 38);// 设置字体及字号 33 content.setTextMatrix(textWidth, textHeight);// 设置起始位置 34 content.showTextAligned(Element.ALIGN_LEFT, text, textWidth, textHeight, 45);// 开始写入水印 35 content.endText(); 36 } 37 stamper.close(); 38 }
2、IText添加书签
1 Document document = new Document(PageSize.A4); 2 3 BaseFont bfCN = 4 BaseFont.createFont("C:/Windows/Fonts/simhei.ttf",BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED); 5 // 章的字体 6 Font chFont = new Font(bfCN, 12, Font.NORMAL, BaseColor.BLUE); 7 // 节的字体 8 Font secFont = new Font(bfCN, 12, Font.NORMAL, new BaseColor(0, 204, 9 255)); 10 // 正文的字体 11 Font textFont = new Font(bfCN, 12, Font.NORMAL, BaseColor.BLACK); 12 13 PdfWriter.getInstance(document, new FileOutputStream(DEST)); 14 document.open(); 15 16 int chNum = 1; 17 Chapter chapter = new Chapter(new Paragraph("Michael介绍", chFont), 18 chNum++); 19 20 Section section = chapter.addSection(new Paragraph("基本信息", secFont)); 21 section.setIndentation(10); 22 section.setIndentationLeft(10); 23 section.setBookmarkOpen(true); 24 section.setNumberStyle(Section.NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT); 25 section.add(new Paragraph("苦逼的码农一枚。。。", textFont)); 26 27 Section section2 = chapter.addSection(new Paragraph("SNS", secFont)); 28 section2.setIndentation(10); 29 section2.setIndentationLeft(10); 30 section2.setBookmarkOpen(false); 31 section2.setNumberStyle(Section.NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT); 32 section2.add(new Paragraph("SNS地址分类:", textFont)); 33 34 section = section2.addSection(new Paragraph(new Chunk("我的博客", secFont) 35 .setUnderline(0.2f, -2f).setAnchor("http://www.cnblogs.com/xiaoSY-learning"))); 36 section.setBookmarkOpen(false); 37 section.setIndentation(10); 38 section.setIndentationLeft(10); 39 section.setNumberStyle(Section.NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT); 40 section.add(new Paragraph(new Chunk("我的blog地址:http://www.cnblogs.com/xiaoSY-learning/", 41 textFont).setUnderline(0.2f, -2f).setAnchor( 42 "http://www.cnblogs.com/xiaoSY-learning/"))); 43 section.add(new Paragraph("分享自己的技术心得。", textFont)); 44 45 section = section2.addSection(new Paragraph(new Chunk("我的weibo", 46 secFont).setUnderline(0.2f, -2f).setAnchor( 47 "http://weibo.com/u/2772113512"))); 48 section.setIndentation(10); 49 section.setIndentationLeft(10); 50 section.setBookmarkOpen(false); 51 section.setNumberStyle(Section.NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT); 52 section.add(new Paragraph(new Chunk("我的weibo:http://weibo.com/u/2772113512", 53 textFont).setUnderline(0.2f, -2f).setAnchor( 54 "http://weibo.com/u/2772113512"))); 55 section.add(new Paragraph("发表下心情,分享下技术,转转乱七八糟的新闻。", textFont)); 56 57 section = section2.addSection(new Paragraph(new Chunk("twitter", 58 secFont))); 59 section.setIndentation(10); 60 section.setIndentationLeft(10); 61 section.setBookmarkOpen(false); 62 section.setNumberStyle(Section.NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT); 63 section.add(new Paragraph(new Chunk("twitter:@suncto", textFont) 64 .setUnderline(0.2f, -2f).setAnchor("twitter:twitter:twitter:"))); 65 section.add(new Paragraph("一个常常被墙的地方", textFont)); 66 67 LineSeparator line = new LineSeparator(1, 100, new BaseColor(204, 204, 68 204), Element.ALIGN_CENTER, -2); 69 70 Paragraph p_line = new Paragraph("分割线"); 71 p_line.add(line); 72 chapter.add(p_line); 73 document.add(chapter); 74 75 chapter = new Chapter(new Paragraph("Miu的介绍", chFont), chNum++); 76 section = chapter.addSection(new Paragraph("基本信息", secFont)); 77 section.setIndentation(10); 78 section.setIndentationLeft(10); 79 section.setBookmarkOpen(false); 80 section.setNumberStyle(Section.NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT); 81 section.add(new Paragraph("90后一枚,喜欢美食和旅游。。。", textFont)); 82 83 document.add(chapter); 84 85 document.close();
3、IText创建PDF
1 import java.io.File; 2 import java.io.FileOutputStream; 3 import java.io.OutputStream; 4 import java.util.Date; 5 6 import com.itextpdf.text.Document; 7 import com.itextpdf.text.Paragraph; 8 import com.itextpdf.text.pdf.PdfWriter; 9 10 public class PDFJiemi { 11 12 private static String USER_PASS = "Hello123"; 13 14 private static String OWNER_PASS = "Owner123"; 15 16 public static void main(String[] args) { 17 18 try { 19 20 OutputStream file = new FileOutputStream(new File("E:\\pdfile\\NeedToDo\\Jiemi\\Test2.pdf")); 21 22 Document document = new Document(); 23 PdfWriter writer = PdfWriter.getInstance(document, file); 24 25 writer.setEncryption(USER_PASS.getBytes(), OWNER_PASS.getBytes(), 26 PdfWriter.ALLOW_PRINTING, PdfWriter.ENCRYPTION_AES_128); 27 28 document.open(); 29 document.add(new Paragraph("Hello World, iText")); 30 document.add(new Paragraph(new Date().toString())); 31 32 document.close(); 33 file.close(); 34 35 } catch (Exception e) { 36 37 e.printStackTrace(); 38 } 39 System.out.println("OK."); 40 } 41 }
4、附上PDFBox判断PDF文档是否加密
1 import java.io.File; 2 import java.io.IOException; 3 4 import org.apache.pdfbox.pdmodel.PDDocument; 5 6 public class PDFIsEncrypted { 7 8 public static void main(String[] args) throws IOException { 9 10 PDDocument pdf = PDDocument.load(new File("E:\\pdfile\\NeedToDo\\Jiemi\\addWaterTest.pdf")); 11 12 System.out.println("isEncrypted : " + pdf.isEncrypted()); 13 } 14 15 }
IText入门必须要知道的东西