OFDDoc (ofdrw-layout 2.3.4 API)

java.lang.Object
- org.ofdrw.layout.OFDDoc

所有已实现的接口:

Closeable, AutoCloseable
```
public class OFDDoc
extends Object
implements Closeable
```
Virtual Document 虚拟文档对象
与 Document 区别
使用API的方式构造OFD文档，并打包为OFD文件。

从以下版本开始:

2020-3-17 20:13:51

作者:

权观宇

构造器概要

构造器
构造器和说明
`OFDDoc(OFDReader reader, OutputStream outStream)` 修改一个OFD文档
`OFDDoc(OFDReader reader, Path outPath)` 修改一个OFD文档
`OFDDoc(OutputStream outStream)` 在指定路径位置上创建一个OFD文件
`OFDDoc(Path outPath)` 在指定路径位置上创建一个OFD文件

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`OFDDoc`	`add(Div item)` 向文档中加入元素适合于流式布局
`OFDDoc`	`addAnnotation(int pageNum, Annotation annotation)` 向页面中增加注释对象
`OFDDoc`	`addAttachment(Attachment attachment)` 向文档中添加附件文件如果名称相同原有附件将会被替换，附件文件将被放置于文档的默认资源目录下"/Doc_0/Res/"。
`OFDDoc`	`addAttachment(String absPath, Attachment attachment)` 向文档中添加附件文件如果名称相同原有附件将会被替换，附件文件将被放置于指定目录下。
`OFDDoc`	`addStreamCollect(StreamCollect streamCollect)` 向文档中加入虚拟页面适合编辑时，添加流式的内容
`OFDDoc`	`addVPage(VirtualPage virtualPage)` 向文档中加入虚拟页面适合于固定布局
`OFDDoc`	`addWatermark(Watermark watermark)` 给整个文档增加水印.
`void`	`close()` 关闭文档，生成OFD 注所有文档操作均在close方法执行完成后才会写入文件，打包生成OFD文档。
`OFDDoc`	`deleteAttachment(String name)` 删除指定名称的附件
`AdditionVPage`	`getAVPage(int pageNum)` 获取指定页面追加页面对象并且追加到虚拟页面列表中
`OFDDir`	`getOfdDir()` 获取 OFD虚拟容器通过虚拟容器API就可以直接操作XML文件和目录结构
`org.ofdrw.core.basicStructure.doc.Document`	`getOfdDocument()` 获取文档根节点根节点中包含了文档各类信息的入口
`VPageHandler`	`getOnPage()` 获取当前解析页面的回调
`PageLayout`	`getPageLayout()` 获取页面样式（只读）如果需要重新设置默认的页面样式那么请使用 `setDefaultPageLayout(org.ofdrw.layout.PageLayout)`
`OFDReader`	`getReader()` 返回正在编辑文档的Reader对象若为新建文档那么该方法将会返回null
`ResManager`	`getResManager()` 获取资源管理器对象通过资源管理器API就可以直接操作文档资源
`OFDDoc`	`onPage(VPageHandler handler)` 设置当前解析页面的回调函数通过回调函数可在页面变为OFD内容前向页面追加内容，例如：添加页头、添加页脚。
`OFDDoc`	`onRenderFinish(RenderFinishHandler renderFinishHandler)` 当渲染结束时的回调函数
`OFDDoc`	`setDefaultPageLayout(PageLayout pageLayout)` 设置页面默认的样式

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

- 构造器详细资料
  - OFDDoc
```
public OFDDoc(Path outPath)
```
    在指定路径位置上创建一个OFD文件
    
    参数:
    
    outPath - OFD输出路径
  - OFDDoc
```
public OFDDoc(OutputStream outStream)
```
    在指定路径位置上创建一个OFD文件
    
    参数:
    
    outStream - OFD输出流，由调用者负责关闭。
  - OFDDoc
```
public OFDDoc(OFDReader reader,
              Path outPath)
       throws DocReadException
```
    修改一个OFD文档
    
    参数:
    
    reader - OFD解析器
    
    outPath - 修改后文档生成位置
    
    抛出:
    
    DocReadException - 文档读取异常
  - OFDDoc
```
public OFDDoc(OFDReader reader,
              OutputStream outStream)
       throws DocReadException
```
    修改一个OFD文档
    
    参数:
    
    reader - OFD解析器
    
    outStream - 修改后文档输出流
    
    抛出:
    
    DocReadException - 文档读取异常
- 方法详细资料
  - setDefaultPageLayout
```
public OFDDoc setDefaultPageLayout(PageLayout pageLayout)
```
    设置页面默认的样式
    
    参数:
    
    pageLayout - 页面默认样式
    
    返回:
    
    this
  - add
```
public OFDDoc add(Div item)
```
    向文档中加入元素
    适合于流式布局
    
    参数:
    
    item - 元素
    
    返回:
    
    this
  - addVPage
```
public OFDDoc addVPage(VirtualPage virtualPage)
```
    向文档中加入虚拟页面
    适合于固定布局
    
    参数:
    
    virtualPage - 虚拟页面
    
    返回:
    
    this
  - addStreamCollect
```
public OFDDoc addStreamCollect(StreamCollect streamCollect)
```
    向文档中加入虚拟页面
    适合编辑时，添加流式的内容
    
    参数:
    
    streamCollect - 流式页面
    
    返回:
    
    this
  - getAVPage
```
public AdditionVPage getAVPage(int pageNum)
```
    获取指定页面追加页面对象
    并且追加到虚拟页面列表中
    
    参数:
    
    pageNum - 页码，从1起。
    
    返回:
    
    追加页面对象
  - addAnnotation
```
public OFDDoc addAnnotation(int pageNum,
                            Annotation annotation)
                     throws IOException
```
    向页面中增加注释对象
    
    参数:
    
    pageNum - 页码
    
    annotation - 注释对象
    
    返回:
    
    this
    
    抛出:
    
    IOException - 文件操作异常
    
    RenderException - 渲染异常
  - getPageLayout
```
public PageLayout getPageLayout()
```
    获取页面样式（只读）
    如果需要重新设置默认的页面样式那么请使用 setDefaultPageLayout(org.ofdrw.layout.PageLayout)
    
    返回:
    
    页面样式(只读)
  - addAttachment
```
public OFDDoc addAttachment(Attachment attachment)
                     throws IOException
```
    向文档中添加附件文件
    如果名称相同原有附件将会被替换，附件文件将被放置于文档的默认资源目录下"/Doc_0/Res/"。
    
    参数:
    
    attachment - 附件文件对象
    
    返回:
    
    this
    
    抛出:
    
    IOException - 文件操作异常
  - addAttachment
```
public OFDDoc addAttachment(String absPath,
                            Attachment attachment)
                     throws IOException
```
    向文档中添加附件文件
    如果名称相同原有附件将会被替换，附件文件将被放置于指定目录下。
    
    参数:
    
    absPath - 附件在OFD容器内的绝对位置，若不存在则创建，例如 "/Doc_0/Res/
    
    attachment - 附件文件对象
    
    返回:
    
    this
    
    抛出:
    
    IOException - 文件操作异常
  - addWatermark
```
public OFDDoc addWatermark(Watermark watermark)
                    throws IOException
```
    给整个文档增加水印. 本方法会遍历整个文档，将水印添加到每个页面中。按照OFD标准 GB/T 33190-2016 15.2 分页注释文件的设计水印应该以一种特殊的注释类型写入。如果要添加图片类型的水印，请使用 Annotation, 参考：addAnnotation(int, Annotation) 如果要为指定页码添加水印，请使用 addAnnotation(int, Annotation)
    
    参数:
    
    watermark - 水印信息
    
    返回:
    
    this
    
    抛出:
    
    IOException - 文件操作异常
  - deleteAttachment
```
public OFDDoc deleteAttachment(String name)
                        throws IOException
```
    删除指定名称的附件
    
    参数:
    
    name - 附件名称，若附件不存在则忽略。
    
    返回:
    
    this
    
    抛出:
    
    IOException - 文件操作异常
  - getOfdDir
```
public OFDDir getOfdDir()
```
    获取 OFD虚拟容器
    通过虚拟容器API就可以直接操作XML文件和目录结构
    
    返回:
    
    OFD虚拟容器
  - getOfdDocument
```
public org.ofdrw.core.basicStructure.doc.Document getOfdDocument()
```
    获取文档根节点
    根节点中包含了文档各类信息的入口
    
    返回:
    
    文档根节点
  - onRenderFinish
```
public OFDDoc onRenderFinish(RenderFinishHandler renderFinishHandler)
```
    当渲染结束时的回调函数
    
    参数:
    
    renderFinishHandler - OFD渲染结束时回调函数，可以为null，不调用
    
    返回:
    
    this
  - getReader
```
public OFDReader getReader()
```
    返回正在编辑文档的Reader对象
    若为新建文档那么该方法将会返回null
    
    返回:
    
    正在编辑文档的Reader对象
  - getResManager
```
public ResManager getResManager()
```
    获取资源管理器对象
    通过资源管理器API就可以直接操作文档资源
    
    返回:
    
    OFD虚拟容器
  - getOnPage
```
public VPageHandler getOnPage()
```
    获取当前解析页面的回调
    
    返回:
    
    当前解析页面的回调，可能为 null 。
  - onPage
```
public OFDDoc onPage(VPageHandler handler)
```
    设置当前解析页面的回调函数
    通过回调函数可在页面变为OFD内容前向页面追加内容，例如：添加页头、添加页脚。
    
    参数:
    
    handler - 页面解析前处理器
    
    返回:
    
    this
  - close
```
public void close()
           throws IOException
```
    关闭文档，生成OFD
    注所有文档操作均在close方法执行完成后才会写入文件，打包生成OFD文档。每个打开的文档都应该调用该方法。
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - 文档操作异常

类 OFDDoc

构造器概要

方法概要

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

构造器详细资料

OFDDoc

OFDDoc

OFDDoc

OFDDoc

方法详细资料

setDefaultPageLayout

add

addVPage

addStreamCollect

getAVPage

addAnnotation

getPageLayout

addAttachment

addAttachment

addWatermark

deleteAttachment

getOfdDir

getOfdDocument

onRenderFinish

getReader

getResManager

getOnPage

onPage

close