XEasyPdfDocument (x-easypdf-pdfbox 2.12.2 API)

java.lang.Object
- org.dromara.pdf.pdfbox.doc.XEasyPdfDocument

所有已实现的接口:

Closeable, Serializable, AutoCloseable
```
public class XEasyPdfDocument
extends Object
implements Closeable, Serializable
```
pdf文档

从以下版本开始:

1.8
Copyright (c) 2020-2023 xsx All Rights Reserved. x-easypdf is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

作者:

xsx

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明
`XEasyPdfDocument()` 无参构造
`XEasyPdfDocument(InputStream inputStream)` 有参构造
`XEasyPdfDocument(InputStream inputStream, String password)` 有参构造
`XEasyPdfDocument(InputStream inputStream, String password, InputStream keyStore, String alias)` 有参构造
`XEasyPdfDocument(String filePath)` 有参构造
`XEasyPdfDocument(String filePath, String password)` 有参构造
`XEasyPdfDocument(String filePath, String password, InputStream keyStore, String alias)` 有参构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addFont(String fontPath, org.apache.pdfbox.pdmodel.font.PDFont font)` 添加文档字体
`void`	`addOtfFont(String fontPath, org.apache.pdfbox.pdmodel.font.PDFont font)` 添加文档otf字体
`XEasyPdfDocument`	`addPage(List<XEasyPdfPage> pages)` 添加pdf页面
`XEasyPdfDocument`	`addPage(XEasyPdfPage... pages)` 添加pdf页面
`XEasyPdfDocumentAnalyzer`	`analyzer()` 获取文档分析器
`XEasyPdfDocumentBookmark`	`bookmark()` 获取文档书签
`void`	`close()` 关闭文档
`XEasyPdfDocument`	`enableReplaceTotalPagePlaceholder()` 开启总页码占位符替换
`XEasyPdfDocument`	`enableResetContext()` 开启重置上下文
`XEasyPdfDocumentExtractor`	`extractor()` 获取文档提取器
`XEasyPdfDocument`	`flush()` 刷新（临时保存）
`XEasyPdfDocumentFormFiller`	`formFiller()` 获取表单填充器
`org.apache.pdfbox.pdmodel.font.PDFont`	`getFont()` 获取文档字体
`org.apache.pdfbox.pdmodel.font.PDFont`	`getFont(String fontPath)` 获取文档字体
`String`	`getFontPath()` 获取文档字体路径
`Color`	`getGlobalBackgroundColor()` 获取文档背景色
`XEasyPdfImage`	`getGlobalBackgroundImage()` 获取文档背景图片
`XEasyPdfComponent.ContentMode`	`getGlobalContentMode()` 获取文档内容模式
`XEasyPdfFooter`	`getGlobalFooter()` 获取全局页脚
`XEasyPdfHeader`	`getGlobalHeader()` 获取全局页眉
`XEasyPdfWatermark`	`getGlobalWatermark()` 获取全局水印
`org.apache.pdfbox.pdmodel.font.PDFont`	`getOtfFont(String fontPath)` 获取文档otf字体
`List<XEasyPdfPage>`	`getPageList()` 获取pdf页面列表
`org.apache.pdfbox.pdmodel.PDDocument`	`getTarget()` 获取任务文档
`int`	`getTotalPage()` 获取文档总页数
`XEasyPdfDocumentImager`	`imager()` 获取文档图像器
`XEasyPdfDocumentInfo`	`information()` 获取文档信息
`XEasyPdfDocument`	`insertPage(int pageIndex, List<XEasyPdfPage> pages)` 插入pdf页面
`XEasyPdfDocument`	`insertPage(int pageIndex, XEasyPdfPage... pages)` 插入pdf页面
`XEasyPdfDocument`	`merge(XEasyPdfDocument... documents)` 合并文档
`XEasyPdfDocument`	`modifyPageSize(XEasyPdfPageRectangle pageSize, int... pageIndex)` 修改页面尺寸
`XEasyPdfDocumentPermission`	`permission()` 获取文档权限
`XEasyPdfDocument`	`print(int count)` 打印文档（默认打印机）
`XEasyPdfDocument`	`print(int count, XEasyPdfPrintStyle style, org.apache.pdfbox.printing.Scaling scaling)` 打印文档（默认打印机）
`XEasyPdfDocument`	`removePage(int... pageIndex)` 移除pdf页面
`XEasyPdfDocumentReplacer`	`replacer()` 获取文档替换器
`XEasyPdfDocument`	`save(OutputStream outputStream)` 保存（页面构建）
`XEasyPdfDocument`	`save(String outputPath)` 保存（页面构建）
`XEasyPdfDocument`	`setDefaultFontStyle(XEasyPdfDefaultFontStyle style)` 设置默认字体样式
`XEasyPdfDocument`	`setFontPath(String fontPath)` 设置字体路径
`XEasyPdfDocument`	`setGlobalBackgroundColor(Color globalBackgroundColor)` 设置文档背景色（每个页面都将添加背景色）
`XEasyPdfDocument`	`setGlobalBackgroundImage(XEasyPdfImage globalBackgroundImage)` 设置文档背景图片（每个页面都将添加背景图片）
`XEasyPdfDocument`	`setGlobalContentMode(XEasyPdfComponent.ContentMode contentMode)` 设置文档内容模式（每个页面都将设置该模式）
`XEasyPdfDocument`	`setGlobalFooter(XEasyPdfFooter globalFooter)` 设置文档页脚（每个页面都将添加页脚）
`XEasyPdfDocument`	`setGlobalHeader(XEasyPdfHeader globalHeader)` 设置文档页眉（每个页面都将添加页眉）
`XEasyPdfDocument`	`setGlobalWatermark(XEasyPdfWatermark globalWatermark)` 设置文档水印（每个页面都将添加水印）
`XEasyPdfDocument`	`setTempDir(String tempDir)` 设置临时目录（用于flush操作），需读写权限默认在项目路径的根目录 eg：当前项目在“D:\test\pdf”目录下，临时文件存放目录则为“D:\”
`XEasyPdfDocument`	`setVersion(float version)` 设置版本
`XEasyPdfDocumentSigner`	`signer()` 获取文档签名器
`XEasyPdfDocumentSplitter`	`splitter()` 获取文档拆分器

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - XEasyPdfDocument
```
public XEasyPdfDocument()
```
    无参构造
  - XEasyPdfDocument
```
public XEasyPdfDocument(String filePath)
```
    有参构造
    
    参数:
    
    filePath - pdf文件路径
  - XEasyPdfDocument
```
public XEasyPdfDocument(String filePath,
                        String password)
```
    有参构造
    
    参数:
    
    filePath - pdf文件路径
    
    password - 密码
  - XEasyPdfDocument
```
public XEasyPdfDocument(String filePath,
                        String password,
                        InputStream keyStore,
                        String alias)
```
    有参构造
    
    参数:
    
    filePath - pdf文件路径
    
    password - 密码
    
    keyStore - 证书输入流
    
    alias - 证书别名
  - XEasyPdfDocument
```
public XEasyPdfDocument(InputStream inputStream)
```
    有参构造
    
    参数:
    
    inputStream - 数据流
  - XEasyPdfDocument
```
public XEasyPdfDocument(InputStream inputStream,
                        String password)
```
    有参构造
    
    参数:
    
    inputStream - 数据流
    
    password - 密码
  - XEasyPdfDocument
```
public XEasyPdfDocument(InputStream inputStream,
                        String password,
                        InputStream keyStore,
                        String alias)
```
    有参构造
    
    参数:
    
    inputStream - 数据流
    
    password - 密码
    
    keyStore - 证书输入流
    
    alias - 证书别名
- 方法详细资料
  - enableResetContext
```
public XEasyPdfDocument enableResetContext()
```
    开启重置上下文
    
    返回:
    
    返回pdf文档
  - enableReplaceTotalPagePlaceholder
```
public XEasyPdfDocument enableReplaceTotalPagePlaceholder()
```
    开启总页码占位符替换
    
    返回:
    
    返回pdf文档
  - setGlobalContentMode
```
public XEasyPdfDocument setGlobalContentMode(XEasyPdfComponent.ContentMode contentMode)
```
    设置文档内容模式（每个页面都将设置该模式）
    
    返回:
    
    返回pdf文档
  - getGlobalContentMode
```
public XEasyPdfComponent.ContentMode getGlobalContentMode()
```
    获取文档内容模式
    
    返回:
    
    返回文档内容模式
  - setGlobalBackgroundColor
```
public XEasyPdfDocument setGlobalBackgroundColor(Color globalBackgroundColor)
```
    设置文档背景色（每个页面都将添加背景色）
    
    参数:
    
    globalBackgroundColor - 背景色
    
    返回:
    
    返回pdf文档
  - getGlobalBackgroundColor
```
public Color getGlobalBackgroundColor()
```
    获取文档背景色
    
    返回:
    
    返回文档背景色
  - setGlobalBackgroundImage
```
public XEasyPdfDocument setGlobalBackgroundImage(XEasyPdfImage globalBackgroundImage)
```
    设置文档背景图片（每个页面都将添加背景图片）
    
    参数:
    
    globalBackgroundImage - 背景图片
    
    返回:
    
    返回pdf文档
  - getGlobalBackgroundImage
```
public XEasyPdfImage getGlobalBackgroundImage()
```
    获取文档背景图片
    
    返回:
    
    返回pdf图片
  - setGlobalWatermark
```
public XEasyPdfDocument setGlobalWatermark(XEasyPdfWatermark globalWatermark)
```
    设置文档水印（每个页面都将添加水印）
    
    参数:
    
    globalWatermark - 页面水印
    
    返回:
    
    返回pdf文档
  - getGlobalWatermark
```
public XEasyPdfWatermark getGlobalWatermark()
```
    获取全局水印
    
    返回:
    
    返回pdf水印
  - setGlobalHeader
```
public XEasyPdfDocument setGlobalHeader(XEasyPdfHeader globalHeader)
```
    设置文档页眉（每个页面都将添加页眉）
    
    参数:
    
    globalHeader - 页眉
    
    返回:
    
    返回pdf文档
  - getGlobalHeader
```
public XEasyPdfHeader getGlobalHeader()
```
    获取全局页眉
    
    返回:
    
    返回pdf页眉
  - setGlobalFooter
```
public XEasyPdfDocument setGlobalFooter(XEasyPdfFooter globalFooter)
```
    设置文档页脚（每个页面都将添加页脚）
    
    参数:
    
    globalFooter - 页脚
    
    返回:
    
    返回pdf文档
  - getGlobalFooter
```
public XEasyPdfFooter getGlobalFooter()
```
    获取全局页脚
    
    返回:
    
    返回pdf页脚
  - setFontPath
```
public XEasyPdfDocument setFontPath(String fontPath)
```
    设置字体路径
    
    参数:
    
    fontPath - 字体路径
    
    返回:
    
    返回pdf文档
  - setDefaultFontStyle
```
public XEasyPdfDocument setDefaultFontStyle(XEasyPdfDefaultFontStyle style)
```
    设置默认字体样式
    
    参数:
    
    style - 默认字体样式
    
    返回:
    
    返回pdf文档
  - setVersion
```
public XEasyPdfDocument setVersion(float version)
```
    设置版本
    
    参数:
    
    version - 版本
    
    返回:
    
    返回pdf文档
  - setTempDir
```
public XEasyPdfDocument setTempDir(String tempDir)
```
    设置临时目录（用于flush操作），需读写权限
    默认在项目路径的根目录
    
    eg：当前项目在“D:\test\pdf”目录下，临时文件存放目录则为“D:\”
    
    参数:
    
    tempDir - 临时目录
    
    返回:
    
    返回pdf文档
  - addFont
```
public void addFont(String fontPath,
                    org.apache.pdfbox.pdmodel.font.PDFont font)
```
    添加文档字体
    
    参数:
    
    fontPath - 字体路径
    
    font - pdfbox字体
  - addOtfFont
```
public void addOtfFont(String fontPath,
                       org.apache.pdfbox.pdmodel.font.PDFont font)
```
    添加文档otf字体
    
    参数:
    
    fontPath - 字体路径
    
    font - pdfbox字体
  - getFont
```
public org.apache.pdfbox.pdmodel.font.PDFont getFont()
```
    获取文档字体
    
    返回:
    
    返回pdfBox字体
  - getFont
```
public org.apache.pdfbox.pdmodel.font.PDFont getFont(String fontPath)
```
    获取文档字体
    
    参数:
    
    fontPath - 字体路径
    
    返回:
    
    返回pdfbox字体
  - getOtfFont
```
public org.apache.pdfbox.pdmodel.font.PDFont getOtfFont(String fontPath)
```
    获取文档otf字体
    
    参数:
    
    fontPath - 字体路径
    
    返回:
    
    返回pdfbox字体
  - getFontPath
```
public String getFontPath()
```
    获取文档字体路径
    
    返回:
    
    返回文档字体路径
  - getTarget
```
public org.apache.pdfbox.pdmodel.PDDocument getTarget()
```
    获取任务文档
    
    返回:
    
    返回任务文档
  - getPageList
```
public List<XEasyPdfPage> getPageList()
```
    获取pdf页面列表
    
    返回:
    
    返回pdf页面列表
  - getTotalPage
```
public int getTotalPage()
```
    获取文档总页数
    
    返回:
    
    返回文档总页数
  - addPage
```
public XEasyPdfDocument addPage(XEasyPdfPage... pages)
```
    添加pdf页面
    
    参数:
    
    pages - pdf页面
    
    返回:
    
    返回pdf文档
  - addPage
```
public XEasyPdfDocument addPage(List<XEasyPdfPage> pages)
```
    添加pdf页面
    
    参数:
    
    pages - pdf页面
    
    返回:
    
    返回pdf文档
  - insertPage
```
public XEasyPdfDocument insertPage(int pageIndex,
                                   XEasyPdfPage... pages)
```
    插入pdf页面
    
    参数:
    
    pageIndex - 页面索引
    
    pages - pdf页面
    
    返回:
    
    返回pdf文档
  - insertPage
```
public XEasyPdfDocument insertPage(int pageIndex,
                                   List<XEasyPdfPage> pages)
```
    插入pdf页面
    
    参数:
    
    pageIndex - 页面索引
    
    pages - pdf页面列表
    
    返回:
    
    返回pdf文档
  - modifyPageSize
```
public XEasyPdfDocument modifyPageSize(XEasyPdfPageRectangle pageSize,
                                       int... pageIndex)
```
    修改页面尺寸
    
    参数:
    
    pageSize - pdf页面尺寸
    
    pageIndex - 页面索引
    
    返回:
    
    返回pdf文档
  - removePage
```
public XEasyPdfDocument removePage(int... pageIndex)
```
    移除pdf页面
    
    参数:
    
    pageIndex - 页面索引
    
    返回:
    
    返回pdf文档
  - merge
```
public XEasyPdfDocument merge(XEasyPdfDocument... documents)
```
    合并文档
    
    参数:
    
    documents - pdf文档
    
    返回:
    
    返回pdf文档
  - information
```
public XEasyPdfDocumentInfo information()
```
    获取文档信息
    
    返回:
    
    返回pdf文档信息
  - permission
```
public XEasyPdfDocumentPermission permission()
```
    获取文档权限
    
    返回:
    
    返回pdf文档权限
  - bookmark
```
public XEasyPdfDocumentBookmark bookmark()
```
    获取文档书签
    
    返回:
    
    返回pdf文档书签
  - replacer
```
public XEasyPdfDocumentReplacer replacer()
```
    获取文档替换器
    
    返回:
    
    返回pdf文档替换器
  - formFiller
```
public XEasyPdfDocumentFormFiller formFiller()
```
    获取表单填充器
    
    返回:
    
    返回pdf文档表单填写器
  - imager
```
public XEasyPdfDocumentImager imager()
```
    获取文档图像器
    
    返回:
    
    返回pdf文档图像器
  - splitter
```
public XEasyPdfDocumentSplitter splitter()
```
    获取文档拆分器
    
    返回:
    
    返回pdf文档拆分器
  - extractor
```
public XEasyPdfDocumentExtractor extractor()
```
    获取文档提取器
    
    返回:
    
    返回pdf文档提取器
  - signer
```
public XEasyPdfDocumentSigner signer()
```
    获取文档签名器
    
    返回:
    
    返回pdf文档签名器
  - analyzer
```
public XEasyPdfDocumentAnalyzer analyzer()
```
    获取文档分析器
    
    返回:
    
    返回pdf文档分析器
  - flush
```
public XEasyPdfDocument flush()
```
    刷新（临时保存）
    
    返回:
    
    返回pdf文档
  - save
```
public XEasyPdfDocument save(String outputPath)
```
    保存（页面构建）
    
    参数:
    
    outputPath - 文件输出路径
    
    返回:
    
    返回pdf文档
  - save
```
public XEasyPdfDocument save(OutputStream outputStream)
```
    保存（页面构建）
    
    参数:
    
    outputStream - 文件输出流
    
    返回:
    
    返回pdf文档
  - print
```
public XEasyPdfDocument print(int count)
```
    打印文档（默认打印机）
    
    参数:
    
    count - 打印数量
    
    返回:
    
    返回pdf文档
  - print
```
public XEasyPdfDocument print(int count,
                              XEasyPdfPrintStyle style,
                              org.apache.pdfbox.printing.Scaling scaling)
```
    打印文档（默认打印机）
    
    参数:
    
    count - 打印数量
    
    style - 打印形式（横向、纵向、反向横向）
    
    scaling - 缩放比例
    
    返回:
    
    返回pdf文档
  - close
```
public void close()
```
    关闭文档
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable

类 XEasyPdfDocument

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

XEasyPdfDocument

XEasyPdfDocument

XEasyPdfDocument

XEasyPdfDocument

XEasyPdfDocument

XEasyPdfDocument

XEasyPdfDocument

方法详细资料

enableResetContext

enableReplaceTotalPagePlaceholder

setGlobalContentMode

getGlobalContentMode

setGlobalBackgroundColor

getGlobalBackgroundColor

setGlobalBackgroundImage

getGlobalBackgroundImage

setGlobalWatermark

getGlobalWatermark

setGlobalHeader

getGlobalHeader

setGlobalFooter

getGlobalFooter

setFontPath

setDefaultFontStyle

setVersion

setTempDir

addFont

addOtfFont

getFont

getFont

getOtfFont

getFontPath

getTarget

getPageList

getTotalPage

addPage

addPage

insertPage

insertPage

modifyPageSize

removePage

merge

information

permission

bookmark

replacer

formFiller

imager

splitter

extractor

signer

analyzer

flush

save

save

print

print

close