org.dromara.pdf.pdfbox.core.base

类 Document

java.lang.Object

org.dromara.pdf.pdfbox.core.base.AbstractBase

org.dromara.pdf.pdfbox.core.base.Document

所有已实现的接口:

Closeable, AutoCloseable

public class Document
extends AbstractBase
implements Closeable

文档

从以下版本开始:

1.8

Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-pdfbox 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

字段概要

字段

限定符和类型	字段和说明
protected org.apache.pdfbox.pdmodel.encryption.AccessPermission	accessPermission pdf访问权限
protected Color	backgroundColor 背景颜色
protected FontConfiguration	fontConfiguration 字体配置
protected Boolean	isFlushMetadata 是否刷新元数据
protected MarginConfiguration	marginConfiguration 边框配置
protected List<Page>	pages 页面列表
protected PDDocument	target 任务文档
protected Integer	totalPageNumber 总页码
protected Float	version 文档版本

从类继承的字段 org.dromara.pdf.pdfbox.core.base.AbstractBase

contentMode, context, isResetContentStream, log

构造器概要

构造器

构造器和说明
Document() 无参构造
Document(byte[] bytes, String password, InputStream keyStore, String alias, MemoryPolicy policy) 有参构造
Document(File file, String password, InputStream keyStore, String alias, MemoryPolicy policy) 有参构造
Document(InputStream inputStream, String password, InputStream keyStore, String alias, MemoryPolicy policy) 有参构造
Document(MemoryPolicy policy) 有参构造

方法概要

限定符和类型	方法和说明
void	appendPage(List<Page> pages) 追加页面
void	appendPage(Page... pages) 追加页面
void	close() 关闭文档
void	decrypt() 解密 注：需读取文档时，传入密码
void	encryption() 加密（标准）
void	encryption(boolean preferAES, PWLength length, String ownerPassword, String userPassword) 加密（标准）
void	encryption(InputStream certificateInputStream) 加密（公钥） 注：仅支持"X.509"
List<CatalogInfo>	getCatalogs() 获取目录列表
Float	getCharacterSpacing() 获取字符间距
Page	getCurrentPage() 获取当前页面
PDFont	getFont() 获取字体
Float	getFontAlpha() 获取字体透明度
Color	getFontColor() 获取字体颜色
String	getFontName() 获取字体名称
Float	getFontSize() 获取字体大小
Float	getFontSlope() 获取字体斜率
FontStyle	getFontStyle() 获取字体样式
Float	getLeading() 获取行间距
Float	getMarginBottom() 获取下边距
Float	getMarginLeft() 获取左边距
Float	getMarginRight() 获取右边距
Float	getMarginTop() 获取上边距
Page	getPage(int index) 获取指定页面
List<String>	getSpecialFontNames() 获取特殊字体名称
Color	getStrokColor() 获取字体描边颜色
int	getTotalPageNumber() 获取总页数
protected void	init() 初始化
protected void	init(byte[] bytes, String password, InputStream keyStore, String alias, MemoryPolicy policy) 初始化
protected void	init(File file, String password, InputStream keyStore, String alias, MemoryPolicy policy) 初始化
protected void	init(InputStream inputStream, String password, InputStream keyStore, String alias, MemoryPolicy policy) 初始化
protected void	init(MemoryPolicy policy) 初始化
void	initBase() 初始化基础
protected void	initLoad() 初始化加载
protected void	initLoad(org.apache.pdfbox.io.RandomAccessReadBuffer buffer, String password, InputStream keyStore, String alias, MemoryPolicy policy) 初始化
protected void	initOtherParams() 初始化其他参数
protected void	initPages() 初始化页面列表
void	insertPage(int index, Page page) 插入页面
void	save(File file) 保存文档
void	save(OutputStream outputStream) 保存文档
void	save(String path) 保存文档
void	saveAndClose(File file) 保存关闭文档
void	saveAndClose(OutputStream outputStream) 保存关闭文档
void	saveAndClose(String path) 保存关闭文档
void	setCharacterSpacing(float spacing) 设置字符间距
void	setFontAlpha(float alpha) 设置字体透明度
void	setFontColor(Color color) 设置字体颜色
void	setFontName(String fontName) 设置字体名称
void	setFontSize(float size) 设置字体大小
void	setFontSlope(float slope) 设置字体斜率（斜体字）
void	setFontStyle(FontStyle style) 设置字体样式
void	setLeading(float leading) 设置行间距
void	setMargin(float margin) 设置边距（上下左右）
void	setMarginBottom(float margin) 设置下边距
void	setMarginLeft(float margin) 设置左边距
void	setMarginRight(float margin) 设置右边距
void	setMarginTop(float margin) 设置上边距
void	setPage(int index, Page page) 设置页面（替换）
void	setResourceCache(org.apache.pdfbox.pdmodel.ResourceCache cache) 设置缓存
void	setSpecialFontNames(String... fontNames) 设置特殊字体名称
void	setStrokColor(Color color) 设置字体描边颜色
void	setTextHandler(AbstractTextHandler handler) 设置文本助手
void	setVersion(float version) 设置版本

从类继承的方法 org.dromara.pdf.pdfbox.core.base.AbstractBase

init, init

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

marginConfiguration

protected MarginConfiguration marginConfiguration

边框配置

fontConfiguration

protected FontConfiguration fontConfiguration

字体配置

backgroundColor

protected Color backgroundColor

背景颜色

target

protected PDDocument target

任务文档

pages

protected List<Page> pages

页面列表

accessPermission

protected org.apache.pdfbox.pdmodel.encryption.AccessPermission accessPermission

pdf访问权限

version

protected Float version

文档版本

totalPageNumber

protected Integer totalPageNumber

总页码

isFlushMetadata

protected Boolean isFlushMetadata

是否刷新元数据

构造器详细资料

Document

public Document()

无参构造

Document

public Document(MemoryPolicy policy)

有参构造

参数:

policy - 内存策略

Document

public Document(File file,
                String password,
                InputStream keyStore,
                String alias,
                MemoryPolicy policy)

有参构造

参数:

file - 文件

password - 文件密码

keyStore - 证书输入流

alias - 证书别名

policy - 内存策略

Document

public Document(byte[] bytes,
                String password,
                InputStream keyStore,
                String alias,
                MemoryPolicy policy)

有参构造

参数:

bytes - 字节数组

password - 文件密码

keyStore - 证书输入流

alias - 证书别名

policy - 内存策略

Document

public Document(InputStream inputStream,
                String password,
                InputStream keyStore,
                String alias,
                MemoryPolicy policy)

有参构造

参数:

inputStream - 文件输入流

password - 文件密码

keyStore - 证书输入流

alias - 证书别名

policy - 内存策略

方法详细资料

setVersion

public void setVersion(float version)

设置版本

参数:

version - 版本

setResourceCache

public void setResourceCache(org.apache.pdfbox.pdmodel.ResourceCache cache)

设置缓存

参数:

cache - 缓存

setMargin

public void setMargin(float margin)

设置边距（上下左右）

参数:

margin - 边距

setTextHandler

public void setTextHandler(AbstractTextHandler handler)

设置文本助手

参数:

handler - 助手

getFont

public PDFont getFont()

获取字体

返回:

返回字体

getMarginTop

public Float getMarginTop()

获取上边距

返回:

返回上边距

setMarginTop

public void setMarginTop(float margin)

设置上边距

参数:

margin - 边距

getMarginBottom

public Float getMarginBottom()

获取下边距

返回:

返回下边距

setMarginBottom

public void setMarginBottom(float margin)

设置下边距

参数:

margin - 边距

getMarginLeft

public Float getMarginLeft()

获取左边距

返回:

返回左边距

setMarginLeft

public void setMarginLeft(float margin)

设置左边距

参数:

margin - 边距

getMarginRight

public Float getMarginRight()

获取右边距

返回:

返回右边距

setMarginRight

public void setMarginRight(float margin)

设置右边距

参数:

margin - 边距

getFontName

public String getFontName()

获取字体名称

返回:

返回字体名称

setFontName

public void setFontName(String fontName)

设置字体名称

参数:

fontName - 字体名称

getSpecialFontNames

public List<String> getSpecialFontNames()

获取特殊字体名称

返回:

返回特殊字体名称

setSpecialFontNames

public void setSpecialFontNames(String... fontNames)

设置特殊字体名称

参数:

fontNames - 字体名称

getFontSize

public Float getFontSize()

获取字体大小

返回:

返回字体大小

setFontSize

public void setFontSize(float size)

设置字体大小

参数:

size - 大小

getFontColor

public Color getFontColor()

获取字体颜色

返回:

返回字体颜色

setFontColor

public void setFontColor(Color color)

设置字体颜色

参数:

color - 颜色

getStrokColor

public Color getStrokColor()

获取字体描边颜色

返回:

返回字体描边颜色

setStrokColor

public void setStrokColor(Color color)

设置字体描边颜色

参数:

color - 颜色

getFontAlpha

public Float getFontAlpha()

获取字体透明度

返回:

返回字体透明度

setFontAlpha

public void setFontAlpha(float alpha)

设置字体透明度

参数:

alpha - 透明度

getFontStyle

public FontStyle getFontStyle()

获取字体样式

返回:

返回字体样式

setFontStyle

public void setFontStyle(FontStyle style)

设置字体样式

参数:

style - 样式

getFontSlope

public Float getFontSlope()

获取字体斜率

返回:

返回字体斜率

setFontSlope

public void setFontSlope(float slope)

设置字体斜率（斜体字）

参数:

slope - 斜率

getCharacterSpacing

public Float getCharacterSpacing()

获取字符间距

返回:

返回字符间距

setCharacterSpacing

public void setCharacterSpacing(float spacing)

设置字符间距

参数:

spacing - 间距

getLeading

public Float getLeading()

获取行间距

返回:

返回行间距

setLeading

public void setLeading(float leading)

设置行间距

参数:

leading - 行间距

getTotalPageNumber

public int getTotalPageNumber()

获取总页数

返回:

返回总页数

getCurrentPage

public Page getCurrentPage()

获取当前页面

返回:

返回页面

getPage

public Page getPage(int index)

获取指定页面

参数:

index - 页面索引

返回:

返回页面

getCatalogs

public List<CatalogInfo> getCatalogs()

获取目录列表

返回:

返回目录列表

encryption

public void encryption()

加密（标准）

encryption

public void encryption(boolean preferAES,
                       PWLength length,
                       String ownerPassword,
                       String userPassword)

加密（标准）

参数:

preferAES - AES加密（密码长度为128位时生效）

length - 密码长度（40位，128位，256位）

ownerPassword - 拥有者密码

userPassword - 用户密码

encryption

public void encryption(InputStream certificateInputStream)

加密（公钥）

注：仅支持"X.509"

参数:

certificateInputStream - 公钥证书数据流

decrypt

public void decrypt()

解密

注：需读取文档时，传入密码

insertPage

public void insertPage(int index,
                       Page page)

插入页面

参数:

index - 页面索引

page - 页面

appendPage

public void appendPage(Page... pages)

追加页面

参数:

pages - 页面

appendPage

public void appendPage(List<Page> pages)

追加页面

参数:

pages - 页面

setPage

public void setPage(int index,
                    Page page)

设置页面（替换）

参数:

index - 页面索引

page - 页面

save

public void save(File file)

保存文档

参数:

file - 文件

saveAndClose

public void saveAndClose(File file)

保存关闭文档

参数:

file - 文件

save

public void save(String path)

保存文档

参数:

path - 路径

saveAndClose

public void saveAndClose(String path)

保存关闭文档

参数:

path - 路径

save

public void save(OutputStream outputStream)

保存文档

参数:

outputStream - 输出流

saveAndClose

public void saveAndClose(OutputStream outputStream)

保存关闭文档

参数:

outputStream - 输出流

close

public void close()

关闭文档

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

initBase

public void initBase()

初始化基础

init

protected void init()

初始化

init

protected void init(MemoryPolicy policy)

初始化

init

protected void init(File file,
                    String password,
                    InputStream keyStore,
                    String alias,
                    MemoryPolicy policy)

初始化

参数:

file - 文件

password - 密码

keyStore - 证书

alias - 证书别名

policy - 内存策略

init

protected void init(byte[] bytes,
                    String password,
                    InputStream keyStore,
                    String alias,
                    MemoryPolicy policy)

初始化

参数:

bytes - 字节数组

password - 密码

keyStore - 证书

alias - 证书别名

policy - 内存策略

init

protected void init(InputStream inputStream,
                    String password,
                    InputStream keyStore,
                    String alias,
                    MemoryPolicy policy)

初始化

参数:

inputStream - 输入流

password - 密码

keyStore - 证书

alias - 证书别名

policy - 内存策略

initLoad

protected void initLoad(org.apache.pdfbox.io.RandomAccessReadBuffer buffer,
                        String password,
                        InputStream keyStore,
                        String alias,
                        MemoryPolicy policy)

初始化

参数:

buffer - 访问缓冲

password - 密码

keyStore - 证书

alias - 证书别名

policy - 内存策略

initLoad

protected void initLoad()

初始化加载

initPages

protected void initPages()

初始化页面列表

initOtherParams

protected void initOtherParams()

初始化其他参数