Document (x-easypdf-fop 3.4.2 API)

java.lang.Object
- org.dromara.pdf.fop.core.doc.Document

所有已实现的接口:

DocumentComponent
```
public class Document
extends Object
implements DocumentComponent
```
pdf模板-文档

从以下版本开始:

1.8
Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-fop is licensed under the 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()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Document`	`addBookmark(BookmarkComponent... bookmarks)` 添加书签组件
`Document`	`addBookmark(List<BookmarkComponent> bookmarks)` 添加书签组件
`Document`	`addPage(PageComponent... pages)` 添加页面组件注：不推荐添加多个页面，会影响总页码的准确性
`String`	`getContent()` 获取xsl-fo文档内容
`Document`	`getDocument()` 获取xsl-fo文档
`Integer`	`getTotalPage()` 获取总页数
`void`	`save(OutputStream outputStream)` 保存模板
`void`	`save(String path)` 保存模板
`Document`	`setAuthor(String author)` 设置作者
`Document`	`setConfigPath(String configPath)` 设置配置文件路径（fop配置文件路径）
`Document`	`setCreationDate(Date date)` 设置创建时间
`Document`	`setCreator(String creator)` 设置创建者
`Document`	`setEncryptionLength(Integer length)` 设置加密长度注：长度仅为40、128、256
`Document`	`setIsNewLayout(boolean flag)` 设置是否新布局
`Document`	`setIsNoAccessContent(Boolean flag)` 设置是否禁止复制内容用于辅助工具
`Document`	`setIsNoAnnotations(Boolean flag)` 设置是否禁止注释
`Document`	`setIsNoAssembleDoc(Boolean flag)` 设置是否禁止文档组合
`Document`	`setIsNoCopy(Boolean flag)` 设置是否禁止复制
`Document`	`setIsNoEdit(Boolean flag)` 设置是否禁止编辑
`Document`	`setIsNoFillForm(Boolean flag)` 设置是否禁止填写表单
`Document`	`setIsNoPrint(Boolean flag)` 设置是否禁止打印
`Document`	`setIsNoPrintHQ(Boolean flag)` 设置是否禁止页面提取
`Document`	`setKeywords(String keywords)` 设置关键词
`Document`	`setOwnerPassword(String password)` 设置拥有者密码
`Document`	`setSubject(String subject)` 设置主题
`Document`	`setTitle(String title)` 设置标题
`Document`	`setUserPassword(String password)` 设置用户密码
`Document`	`transform()` 转换
`void`	`transform(OutputStream outputStream)` 转换

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

从接口继承的方法 org.dromara.pdf.fop.core.doc.DocumentComponent
transform

- 构造器详细资料
  - Document
```
public Document()
```
- 方法详细资料
  - setConfigPath
```
public Document setConfigPath(String configPath)
```
    设置配置文件路径（fop配置文件路径）
    
    参数:
    
    configPath - 配置文件路径
    
    返回:
    
    返回pdf模板-文档
  - setEncryptionLength
```
public Document setEncryptionLength(Integer length)
```
    设置加密长度
    注：长度仅为40、128、256
    
    参数:
    
    length - 长度
    
    返回:
    
    返回pdf模板-文档
  - setOwnerPassword
```
public Document setOwnerPassword(String password)
```
    设置拥有者密码
    
    参数:
    
    password - 密码
    
    返回:
    
    返回pdf模板-文档
  - setUserPassword
```
public Document setUserPassword(String password)
```
    设置用户密码
    
    参数:
    
    password - 密码
    
    返回:
    
    返回pdf模板-文档
  - setIsNewLayout
```
public Document setIsNewLayout(boolean flag)
```
    设置是否新布局
    
    返回:
    
    返回pdf模板-文档
  - setIsNoPrint
```
public Document setIsNoPrint(Boolean flag)
```
    设置是否禁止打印
    
    参数:
    
    flag - 是否禁止打印
    
    返回:
    
    返回pdf模板-文档
  - setIsNoEdit
```
public Document setIsNoEdit(Boolean flag)
```
    设置是否禁止编辑
    
    参数:
    
    flag - 是否禁止编辑
    
    返回:
    
    返回pdf模板-文档
  - setIsNoAssembleDoc
```
public Document setIsNoAssembleDoc(Boolean flag)
```
    设置是否禁止文档组合
    
    参数:
    
    flag - 是否禁止文档组合
    
    返回:
    
    返回pdf模板-文档
  - setIsNoCopy
```
public Document setIsNoCopy(Boolean flag)
```
    设置是否禁止复制
    
    参数:
    
    flag - 是否禁止复制
    
    返回:
    
    返回pdf模板-文档
  - setIsNoAccessContent
```
public Document setIsNoAccessContent(Boolean flag)
```
    设置是否禁止复制内容用于辅助工具
    
    参数:
    
    flag - 是否禁止复制内容用于辅助工具
    
    返回:
    
    返回pdf模板-文档
  - setIsNoPrintHQ
```
public Document setIsNoPrintHQ(Boolean flag)
```
    设置是否禁止页面提取
    
    参数:
    
    flag - 是否禁止页面提取
    
    返回:
    
    返回pdf模板-文档
  - setIsNoAnnotations
```
public Document setIsNoAnnotations(Boolean flag)
```
    设置是否禁止注释
    
    参数:
    
    flag - 是否禁止注释
    
    返回:
    
    返回pdf模板-文档
  - setIsNoFillForm
```
public Document setIsNoFillForm(Boolean flag)
```
    设置是否禁止填写表单
    
    参数:
    
    flag - 是否禁止填写表单
    
    返回:
    
    返回pdf模板-文档
  - setTitle
```
public Document setTitle(String title)
```
    设置标题
    
    参数:
    
    title - 标题
    
    返回:
    
    返回pdf模板-文档
  - setAuthor
```
public Document setAuthor(String author)
```
    设置作者
    
    参数:
    
    author - 作者
    
    返回:
    
    返回pdf模板-文档
  - setSubject
```
public Document setSubject(String subject)
```
    设置主题
    
    参数:
    
    subject - 主题
    
    返回:
    
    返回pdf模板-文档
  - setKeywords
```
public Document setKeywords(String keywords)
```
    设置关键词
    
    参数:
    
    keywords - 关键词
    
    返回:
    
    返回pdf模板-文档
  - setCreator
```
public Document setCreator(String creator)
```
    设置创建者
    
    参数:
    
    creator - 创建者
    
    返回:
    
    返回pdf模板-文档
  - setCreationDate
```
public Document setCreationDate(Date date)
```
    设置创建时间
    
    参数:
    
    date - 创建时间
    
    返回:
    
    返回pdf模板-文档
  - addPage
```
public Document addPage(PageComponent... pages)
```
    添加页面组件
    注：不推荐添加多个页面，会影响总页码的准确性
    
    参数:
    
    pages - 页面组件列表
    
    返回:
    
    返回pdf模板-文档
  - addBookmark
```
public Document addBookmark(BookmarkComponent... bookmarks)
```
    添加书签组件
    
    参数:
    
    bookmarks - 书签组件列表
    
    返回:
    
    返回pdf模板-文档
  - addBookmark
```
public Document addBookmark(List<BookmarkComponent> bookmarks)
```
    添加书签组件
    
    参数:
    
    bookmarks - 书签组件列表
    
    返回:
    
    返回pdf模板-文档
  - save
```
public void save(String path)
```
    保存模板
    
    参数:
    
    path - 保存路径
  - save
```
public void save(OutputStream outputStream)
```
    保存模板
    
    参数:
    
    outputStream - 输出流
  - transform
```
public Document transform()
```
    转换
    
    返回:
    
    返回pdf文档
  - transform
```
public void transform(OutputStream outputStream)
```
    转换
    
    指定者:
    
    transform 在接口中 DocumentComponent
    
    参数:
    
    outputStream - 输出流
  - getDocument
```
public Document getDocument()
```
    获取xsl-fo文档
    
    指定者:
    
    getDocument 在接口中 DocumentComponent
    
    返回:
    
    返回xsl-fo文档
  - getContent
```
public String getContent()
```
    获取xsl-fo文档内容
    
    返回:
    
    返回文档内容
  - getTotalPage
```
public Integer getTotalPage()
```
    获取总页数
    
    返回:
    
    返回总页数

类 Document

构造器概要

方法概要

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

从接口继承的方法 org.dromara.pdf.fop.core.doc.DocumentComponent

构造器详细资料

Document

方法详细资料

setConfigPath

setEncryptionLength

setOwnerPassword

setUserPassword

setIsNewLayout

setIsNoPrint

setIsNoEdit

setIsNoAssembleDoc

setIsNoCopy

setIsNoAccessContent

setIsNoPrintHQ

setIsNoAnnotations

setIsNoFillForm

setTitle

setAuthor

setSubject

setKeywords

setCreator

setCreationDate

addPage

addBookmark

addBookmark

save

save

transform

transform

getDocument

getContent

getTotalPage