org.ofdrw.graphics2d

Class OFDGraphicsDocument

java.lang.Object

org.ofdrw.graphics2d.OFDGraphicsDocument

All Implemented Interfaces:

Closeable, AutoCloseable

public class OFDGraphicsDocument
extends Object
implements Closeable

图形OFD文档对象

Since:

2023-1-18 09:45:18

Author:

权观宇

Field Summary

Fields

Modifier and Type	Field and Description
Attachments	attachments 附件列表
CT_CommonData	cdata 文档属性信息，该对象会在初始化是被创建并且添加到文档中 此处只是保留引用，为了方便操作。
DocDir	docDir 正在操作的文档目录
Document	document OFD文档对象
AtomicInteger	MaxUnitID 当前文档中所有对象使用标识的最大值。 初始值为 0。MaxUnitID主要用于文档编辑， 在向文档增加一个新对象时，需要分配一个 新的标识符，新标识符取值宜为 MaxUnitID + 1， 同时需要修改此 MaxUnitID值。
OFDDir	ofdDir OFD 打包
ResManager	resMgr 资源管理器

Constructor Summary

Constructors

Constructor and Description
OFDGraphicsDocument(OutputStream outputStream) 在指定路径位置上创建一个OFD文件流
OFDGraphicsDocument(Path outPath) 在指定路径位置上创建一个OFD文件

Method Summary

Modifier and Type	Method and Description
ST_ID	addAttachment(CT_Attachment attObj, InputStream input) 向文档中添加附件文件
ST_ID	addAttachment(Path file) 向文档中添加附件文件
ST_ID	addDrawParam(CT_DrawParam dp) 添加绘制参数至资源文件中
ST_ID	addResImg(Image img) 添加图片资源
void	close()
ST_ID	newID() 生成新的文档内对象ID
OFDPageGraphics2D	newPage(CT_PageArea pageSize) 创建新页面，返回该页面2D图形对象
OFDPageGraphics2D	newPage(double width, double height) 创建页面，单位毫米

Methods inherited from class java.lang.Object

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

Field Detail

ofdDir

public final OFDDir ofdDir

OFD 打包

MaxUnitID

public final AtomicInteger MaxUnitID

当前文档中所有对象使用标识的最大值。 初始值为 0。MaxUnitID主要用于文档编辑， 在向文档增加一个新对象时，需要分配一个 新的标识符，新标识符取值宜为 MaxUnitID + 1， 同时需要修改此 MaxUnitID值。

cdata

public CT_CommonData cdata

文档属性信息，该对象会在初始化是被创建并且添加到文档中 此处只是保留引用，为了方便操作。

document

public final Document document

OFD文档对象

attachments

public Attachments attachments

附件列表

null表示没有附件

docDir

public final DocDir docDir

正在操作的文档目录

resMgr

public final ResManager resMgr

资源管理器

Constructor Detail

OFDGraphicsDocument

public OFDGraphicsDocument(Path outPath)

在指定路径位置上创建一个OFD文件

Parameters:

outPath - OFD输出路径

OFDGraphicsDocument

public OFDGraphicsDocument(OutputStream outputStream)

在指定路径位置上创建一个OFD文件流

Parameters:

outputStream - OFD输出流，应由调用者负责关闭。

Method Detail

newPage

public OFDPageGraphics2D newPage(double width,
                                 double height)

创建页面，单位毫米

Parameters:

width - 页面宽度，单位：毫米

height - 页面高度，单位：毫米

Returns:

2D图形绘制对象

newPage

public OFDPageGraphics2D newPage(CT_PageArea pageSize)

创建新页面，返回该页面2D图形对象

Parameters:

pageSize - 页面大小配置

Returns:

2D图形绘制对象

addResImg

public ST_ID addResImg(Image img)

添加图片资源

Parameters:

img - 图片渲染对象

Returns:

资源ID

Throws:

RuntimeException - 图片转写IO异常

addDrawParam

public ST_ID addDrawParam(CT_DrawParam dp)

添加绘制参数至资源文件中

Parameters:

dp - 绘制参数

Returns:

资源对象ID

newID

public ST_ID newID()

生成新的文档内对象ID

Returns:

文档内对象ID

addAttachment

public ST_ID addAttachment(Path file)
                    throws IOException

向文档中添加附件文件

如果名称相同原有附件将会被替换

Parameters:

file - 附件文件路径

Returns:

加入后的文件附件对象ID

Throws:

IOException - 文件操作异常

addAttachment

public ST_ID addAttachment(CT_Attachment attObj,
                           InputStream input)
                    throws IOException

向文档中添加附件文件

如果已经存在同名文件则替换

Parameters:

attObj - 文件名

input - 附件流

Returns:

加入后的文件附件对象ID

Throws:

IOException - 文件操作异常

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException