cn.hutool.poi.word

Class Word07Writer

java.lang.Object

cn.hutool.poi.word.Word07Writer

All Implemented Interfaces:

Closeable, AutoCloseable

public class Word07Writer
extends Object
implements Closeable

Word docx生成器

Since:

4.4.1

Author:

looly

Field Summary

Fields

Modifier and Type	Field and Description
protected File	destFile 目标文件
protected boolean	isClosed 是否被关闭

Constructor Summary

Constructors

Constructor and Description
Word07Writer()
Word07Writer(File destFile) 构造
Word07Writer(org.apache.poi.xwpf.usermodel.XWPFDocument doc) 构造
Word07Writer(org.apache.poi.xwpf.usermodel.XWPFDocument doc, File destFile) 构造

Method Summary

Modifier and Type	Method and Description
Word07Writer	addPicture(File picFile, int width, int height) 增加图片，单独成段落
Word07Writer	addPicture(InputStream in, PicType picType, String fileName, int width, int height) 增加图片，单独成段落，增加后图片流关闭，默认居中对齐
Word07Writer	addPicture(InputStream in, PicType picType, String fileName, int width, int height, org.apache.poi.xwpf.usermodel.ParagraphAlignment align) 增加图片，单独成段落，增加后图片流关闭
Word07Writer	addTable(Iterable<?> data) 增加表格数据
Word07Writer	addText(Font font, String... texts) 增加一个段落
Word07Writer	addText(org.apache.poi.xwpf.usermodel.ParagraphAlignment align, Font font, String... texts) 增加一个段落
void	close() 关闭Word文档 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
protected void	closeWithoutFlush() 关闭Word文档但是不写出
Word07Writer	flush() 将Excel Workbook刷出到预定义的文件 如果用户未自定义输出的文件，将抛出NullPointerException 预定义文件可以通过setDestFile(File) 方法预定义，或者通过构造定义
Word07Writer	flush(File destFile) 将Excel Workbook刷出到文件 如果用户未自定义输出的文件，将抛出NullPointerException
Word07Writer	flush(OutputStream out) 将Word Workbook刷出到输出流
Word07Writer	flush(OutputStream out, boolean isCloseOut) 将Word Document刷出到输出流
org.apache.poi.xwpf.usermodel.XWPFDocument	getDoc() 获取XWPFDocument
Word07Writer	setDestFile(File destFile) 设置写出的目标文件

Methods inherited from class java.lang.Object

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

Field Detail

destFile

protected File destFile

目标文件

isClosed

protected boolean isClosed

是否被关闭

Constructor Detail

Word07Writer

public Word07Writer()

Word07Writer

public Word07Writer(File destFile)

构造

Parameters:

destFile - 写出的文件

Word07Writer

public Word07Writer(org.apache.poi.xwpf.usermodel.XWPFDocument doc)

构造

Parameters:

doc - XWPFDocument

Word07Writer

public Word07Writer(org.apache.poi.xwpf.usermodel.XWPFDocument doc,
                    File destFile)

构造

Parameters:

doc - XWPFDocument

destFile - 写出的文件

Method Detail

getDoc

public org.apache.poi.xwpf.usermodel.XWPFDocument getDoc()

获取XWPFDocument

Returns:

XWPFDocument

setDestFile

public Word07Writer setDestFile(File destFile)

设置写出的目标文件

Parameters:

destFile - 目标文件

Returns:

this

addText

public Word07Writer addText(Font font,
                            String... texts)

增加一个段落

Parameters:

font - 字体信息Font

texts - 段落中的文本，支持多个文本作为一个段落

Returns:

this

addText

public Word07Writer addText(org.apache.poi.xwpf.usermodel.ParagraphAlignment align,
                            Font font,
                            String... texts)

增加一个段落

Parameters:

align - 段落对齐方式ParagraphAlignment

font - 字体信息Font

texts - 段落中的文本，支持多个文本作为一个段落

Returns:

this

addTable

public Word07Writer addTable(Iterable<?> data)

增加表格数据

Parameters:

data - 表格数据，多行数据。元素表示一行数据，当为集合或者数组时，为一行；当为Map或者Bean时key表示标题，values为数据

Returns:

this

Since:

4.5.16

See Also:

TableUtil.createTable(XWPFDocument, Iterable)

addPicture

public Word07Writer addPicture(File picFile,
                               int width,
                               int height)

增加图片，单独成段落

Parameters:

picFile - 图片文件

width - 宽度

height - 高度

Returns:

this

Since:

5.1.6

addPicture

public Word07Writer addPicture(InputStream in,
                               PicType picType,
                               String fileName,
                               int width,
                               int height)

增加图片，单独成段落，增加后图片流关闭，默认居中对齐

Parameters:

in - 图片流

picType - 图片类型，见Document.PICTURE_TYPE_XXX

fileName - 文件名

width - 宽度

height - 高度

Returns:

this

Since:

5.1.6

addPicture

public Word07Writer addPicture(InputStream in,
                               PicType picType,
                               String fileName,
                               int width,
                               int height,
                               org.apache.poi.xwpf.usermodel.ParagraphAlignment align)

增加图片，单独成段落，增加后图片流关闭

Parameters:

in - 图片流

picType - 图片类型，见Document.PICTURE_TYPE_XXX

fileName - 文件名

width - 宽度

height - 高度

align - 图片的对齐方式

Returns:

this

Since:

5.2.4

flush

public Word07Writer flush()
                   throws IORuntimeException

将Excel Workbook刷出到预定义的文件
如果用户未自定义输出的文件，将抛出NullPointerException
预定义文件可以通过setDestFile(File) 方法预定义，或者通过构造定义

Returns:

this

Throws:

IORuntimeException - IO异常

flush

public Word07Writer flush(File destFile)
                   throws IORuntimeException

将Excel Workbook刷出到文件
如果用户未自定义输出的文件，将抛出NullPointerException

Parameters:

destFile - 写出到的文件

Returns:

this

Throws:

IORuntimeException - IO异常

flush

public Word07Writer flush(OutputStream out)
                   throws IORuntimeException

将Word Workbook刷出到输出流

Parameters:

out - 输出流

Returns:

this

Throws:

IORuntimeException - IO异常

flush

public Word07Writer flush(OutputStream out,
                          boolean isCloseOut)
                   throws IORuntimeException

将Word Document刷出到输出流

Parameters:

out - 输出流

isCloseOut - 是否关闭输出流

Returns:

this

Throws:

IORuntimeException - IO异常

close

public void close()

关闭Word文档
如果用户设定了目标文件，先写出目标文件后给关闭工作簿

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

closeWithoutFlush

protected void closeWithoutFlush()

关闭Word文档但是不写出