cn.hutool.poi.word.Word07Writer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hutool-poi Show documentation
Show all versions of hutool-poi Show documentation
Hutool POI工具类（对Office文档、OFD等操作）
package cn.hutool.poi.word;
import cn.hutool.core.io.FileUtil;
import cn.hutool.core.io.IORuntimeException;
import cn.hutool.core.io.IoUtil;
import cn.hutool.core.lang.Assert;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.poi.exceptions.POIException;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.util.Units;
import org.apache.poi.xwpf.usermodel.ParagraphAlignment;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import java.awt.Font;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
* Word docx生成器
*
* @author looly
* @since 4.4.1
*/
public class Word07Writer implements Closeable {
private final XWPFDocument doc;
/**
* 目标文件
*/
protected File destFile;
/**
* 是否被关闭
*/
protected boolean isClosed;
// -------------------------------------------------------------------------- Constructor start
public Word07Writer() {
this(new XWPFDocument());
}
/**
* 构造
*
* @param destFile 写出的文件
*/
public Word07Writer(File destFile) {
this(DocUtil.create(destFile), destFile);
}
/**
* 构造
*
* @param doc {@link XWPFDocument}
*/
public Word07Writer(XWPFDocument doc) {
this(doc, null);
}
/**
* 构造
*
* @param doc {@link XWPFDocument}
* @param destFile 写出的文件
*/
public Word07Writer(XWPFDocument doc, File destFile) {
this.doc = doc;
this.destFile = destFile;
}
// -------------------------------------------------------------------------- Constructor end
/**
* 获取{@link XWPFDocument}
*
* @return {@link XWPFDocument}
*/
public XWPFDocument getDoc() {
return this.doc;
}
/**
* 设置写出的目标文件
*
* @param destFile 目标文件
* @return this
*/
public Word07Writer setDestFile(File destFile) {
this.destFile = destFile;
return this;
}
/**
* 增加一个段落
*
* @param font 字体信息{@link Font}
* @param texts 段落中的文本，支持多个文本作为一个段落
* @return this
*/
public Word07Writer addText(Font font, String... texts) {
return addText(null, font, texts);
}
/**
* 增加一个段落
*
* @param align 段落对齐方式{@link ParagraphAlignment}
* @param font 字体信息{@link Font}
* @param texts 段落中的文本，支持多个文本作为一个段落
* @return this
*/
public Word07Writer addText(ParagraphAlignment align, Font font, String... texts) {
final XWPFParagraph p = this.doc.createParagraph();
if (null != align) {
p.setAlignment(align);
}
if (ArrayUtil.isNotEmpty(texts)) {
XWPFRun run;
for (String text : texts) {
run = p.createRun();
run.setText(text);
if (null != font) {
run.setFontFamily(font.getFamily());
run.setFontSize(font.getSize());
run.setBold(font.isBold());
run.setItalic(font.isItalic());
}
}
}
return this;
}
/**
* 增加表格数据
*
* @param data 表格数据，多行数据。元素表示一行数据，当为集合或者数组时，为一行；当为Map或者Bean时key表示标题，values为数据
* @return this
* @since 4.5.16
* @see TableUtil#createTable(XWPFDocument, Iterable)
*/
public Word07Writer addTable(Iterable data) {
TableUtil.createTable(this.doc, data);
return this;
}
/**
* 增加图片，单独成段落
*
* @param picFile 图片文件
* @param width 宽度
* @param height 高度
* @return this
* @since 5.1.6
*/
public Word07Writer addPicture(File picFile, int width, int height) {
final String fileName = picFile.getName();
final String extName = FileUtil.extName(fileName).toUpperCase();
PicType picType;
try {
picType = PicType.valueOf(extName);
} catch (IllegalArgumentException e) {
// 默认值
picType = PicType.JPEG;
}
return addPicture(FileUtil.getInputStream(picFile), picType, fileName, width, height);
}
/**
* 增加图片，单独成段落，增加后图片流关闭，默认居中对齐
*
* @param in 图片流
* @param picType 图片类型，见Document.PICTURE_TYPE_XXX
* @param fileName 文件名
* @param width 宽度
* @param height 高度
* @return this
* @since 5.1.6
*/
public Word07Writer addPicture(InputStream in, PicType picType, String fileName, int width, int height) {
return addPicture(in, picType, fileName, width, height, ParagraphAlignment.CENTER);
}
/**
* 增加图片，单独成段落，增加后图片流关闭
*
* @param in 图片流
* @param picType 图片类型，见Document.PICTURE_TYPE_XXX
* @param fileName 文件名
* @param width 宽度
* @param height 高度
* @param align 图片的对齐方式
* @return this
* @since 5.2.4
*/
public Word07Writer addPicture(InputStream in, PicType picType, String fileName, int width, int height, ParagraphAlignment align) {
final XWPFParagraph paragraph = doc.createParagraph();
paragraph.setAlignment(align);
final XWPFRun run = paragraph.createRun();
try {
run.addPicture(in, picType.getValue(), fileName, Units.toEMU(width), Units.toEMU(height));
} catch (InvalidFormatException e) {
throw new POIException(e);
} catch (IOException e) {
throw new IORuntimeException(e);
} finally {
IoUtil.close(in);
}
return this;
}
/**
* 将Excel Workbook刷出到预定义的文件
* 如果用户未自定义输出的文件，将抛出{@link NullPointerException}
* 预定义文件可以通过{@link #setDestFile(File)} 方法预定义，或者通过构造定义
*
* @return this
* @throws IORuntimeException IO异常
*/
public Word07Writer flush() throws IORuntimeException {
return flush(this.destFile);
}
/**
* 将Excel Workbook刷出到文件
* 如果用户未自定义输出的文件，将抛出{@link NullPointerException}
*
* @param destFile 写出到的文件
* @return this
* @throws IORuntimeException IO异常
*/
public Word07Writer flush(File destFile) throws IORuntimeException {
Assert.notNull(destFile, "[destFile] is null, and you must call setDestFile(File) first or call flush(OutputStream).");
return flush(FileUtil.getOutputStream(destFile), true);
}
/**
* 将Word Workbook刷出到输出流
*
* @param out 输出流
* @return this
* @throws IORuntimeException IO异常
*/
public Word07Writer flush(OutputStream out) throws IORuntimeException {
return flush(out, false);
}
/**
* 将Word Document刷出到输出流
*
* @param out 输出流
* @param isCloseOut 是否关闭输出流
* @return this
* @throws IORuntimeException IO异常
*/
public Word07Writer flush(OutputStream out, boolean isCloseOut) throws IORuntimeException {
Assert.isFalse(this.isClosed, "WordWriter has been closed!");
try {
this.doc.write(out);
out.flush();
} catch (IOException e) {
throw new IORuntimeException(e);
} finally {
if (isCloseOut) {
IoUtil.close(out);
}
}
return this;
}
/**
* 关闭Word文档
* 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
*/
@Override
public void close() {
if (null != this.destFile) {
flush();
}
closeWithoutFlush();
}
/**
* 关闭Word文档但是不写出
*/
protected void closeWithoutFlush() {
IoUtil.close(this.doc);
this.isClosed = true;
}
}