org.dromara.pdf.pdfbox.core.base

类 Document

java.lang.Object

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

org.dromara.pdf.pdfbox.core.base.AbstractBaseMargin

org.dromara.pdf.pdfbox.core.base.AbstractBaseBorder

org.dromara.pdf.pdfbox.core.base.AbstractBaseFont

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

所有已实现的接口:

Closeable, AutoCloseable

public class Document
extends AbstractBaseFont
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

构造器概要

构造器

构造器和说明
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() 关闭文档
Page	createPage() 创建页面
Page	createPage(PageSize rectangle) 创建页面
void	decrypt() 解密 注：需读取文档时，传入密码
void	encryption() 加密（标准）
void	encryption(boolean preferAES, PWLength length, String ownerPassword, String userPassword) 加密（标准）
void	encryption(InputStream certificateInputStream) 加密（公钥） 注：仅支持"X.509"
List<CatalogInfo>	getCatalogs() 获取目录列表
Page	getCurrentPage() 获取当前页面
Page	getPage(int index) 获取指定页面
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	initBorderParams() 初始化边框参数
protected void	initFontParams() 初始化字体参数
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	setFontName(String fontName) 设置字体名称
void	setPage(int index, Page page) 设置页面（替换）
void	setResourceCache(org.apache.pdfbox.pdmodel.ResourceCache cache) 设置缓存
void	setVersion(float version) 设置版本

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

init, initFont, setCharacterSpacing, setFontSize, setLeading

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

init, initBorder, setBorderColor, setBorderLineLength, setBorderLineSpacing, setBorderWidth, setIsBorder

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

init, initMargin, initMargin, initMarginWithParam, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

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

init, setHorizontalAlignment, setVerticalAlignment

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

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

构造器详细资料

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 - 内存策略

方法详细资料

setFontName

public void setFontName(String fontName)

设置字体名称

参数:

fontName - 字体名称

setVersion

public void setVersion(float version)

设置版本

参数:

version - 版本

setResourceCache

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

设置缓存

参数:

cache - 缓存

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()

解密

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

createPage

public Page createPage(PageSize rectangle)

创建页面

参数:

rectangle - 页面尺寸

返回:

返回页面

createPage

public Page createPage()

创建页面

返回:

返回页面

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 - 文件

save

public void save(String path)

保存文档

参数:

path - 路径

save

public void save(OutputStream outputStream)

保存文档

参数:

outputStream - 输出流

close

public void close()

关闭文档

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

initBase

public void initBase()

初始化基础

指定者:

initBase 在类中 AbstractBase

init

protected void init()

初始化

覆盖:

init 在类中 AbstractBase

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()

初始化页面列表

initBorderParams

protected void initBorderParams()

初始化边框参数

initFontParams

protected void initFontParams()

初始化字体参数

initOtherParams

protected void initOtherParams()

初始化其他参数