DocumentWrapper (Bigbird Framework 1.0.0-SNAPSHOT API)

java.lang.Object
- wang.bigbird.domain.framework.document.word.wrapper.poi.DocumentWrapper

所有已实现的接口:

Closeable, AutoCloseable
```
public class DocumentWrapper
extends Object
implements Closeable
```
Word文档包装器，包装了2003格式和2007格式的word文档处理逻辑

作者:

Bigbird

构造器概要

构造器
构造器和说明
`DocumentWrapper(org.apache.poi.hwpf.HWPFDocument doc2003)` 包装了2003格式的文档处理器
`DocumentWrapper(org.apache.poi.xwpf.usermodel.XWPFDocument doc2007)` 包装了2007格式的文档处理器
`DocumentWrapper(com.deepoove.poi.XWPFTemplate doc2007plus)` 包装了2007格式的文档处理器

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addTableRow(int tableIndex, int rowIndex)` 在指定行后面增加行
`void`	`close()`
`void`	`drawTable(Map<String,String> headers, Collection<Map<String,Object>> list, Map<Integer,String> rowColorStyleMap, Map<Integer,Integer> rowHeightStyleMap, Map<Integer,Integer> colWidthStyleMap, Set<String> imageColSet, String pattern)` 绘制数据表格
`String`	`getContentFromCell(int tableIndex, int cellRowIndex, int cellColIndex)` 获取表格指定单元格的文本内容
`Map<Integer,ArrayList<String[]>>`	`getTableData()` 将word表格的内容按照最简单的行列模式，构造二维集合返回，集合中一个元素代表一行数据注意，该方法不会读取WORD文档中表格里面的图片数据，也不会读取表格之外的数据。
`ArrayList<String>`	`getTextData()` 将word文本内容逐段读取，该方法适合小页数范围的word内容获取，大页数范围的word内容获取使用该方法有可能导致内存占用过大注意：表格中的每个单元格会被认为是单独一个段落
`void`	`inputTableCellContent(int tableIndex, int cellRowIndex, int cellColIndex, String cellValue)` 往表格指定单元格设置文本内容
`void`	`mergeCell(int tableIndex, int cellRowFromIndex, int cellColFromIndex, int cellRowToIndex, int cellColToIndex)` 合并表格指定区域的单元格
`void`	`render(LinkedHashMap<String,Object> data)` 替换文档中的指定标签，该方法处理后，会将文档中的所有标签都去掉，所以在制作文档前应该只调用一次最佳
`void`	`replaceText(LinkedHashMap<String,String> texts)` 替换文档中的指定文本
`void`	`write(OutputStream outputStream)` 文档写入到指定的输出流

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

- 构造器详细资料
  - DocumentWrapper
```
public DocumentWrapper(org.apache.poi.hwpf.HWPFDocument doc2003)
```
    包装了2003格式的文档处理器
    
    参数:
    
    doc2003 - 2003格式的文档处理器
  - DocumentWrapper
```
public DocumentWrapper(org.apache.poi.xwpf.usermodel.XWPFDocument doc2007)
```
    包装了2007格式的文档处理器
    
    参数:
    
    doc2007 - 2007格式的文档处理器
  - DocumentWrapper
```
public DocumentWrapper(com.deepoove.poi.XWPFTemplate doc2007plus)
```
    包装了2007格式的文档处理器
    
    参数:
    
    doc2007plus - 2007格式的文档处理器增强版
- 方法详细资料
  - replaceText
```
public void replaceText(LinkedHashMap<String,String> texts)
```
    替换文档中的指定文本
    
    参数:
    
    texts - 替换文本的映射关系
  - write
```
public void write(OutputStream outputStream)
           throws IOException
```
    文档写入到指定的输出流
    
    参数:
    
    outputStream - 文档数据输出流
    
    抛出:
    
    IOException - 输出文档数据过程中，可能抛出该异常
  - render
```
public void render(LinkedHashMap<String,Object> data)
```
    替换文档中的指定标签，该方法处理后，会将文档中的所有标签都去掉，所以在制作文档前应该只调用一次最佳
    
    参数:
    
    data - 替换数据的映射关系
  - close
```
public void close()
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
  - getTableData
```
public Map<Integer,ArrayList<String[]>> getTableData()
```
    将word表格的内容按照最简单的行列模式，构造二维集合返回，集合中一个元素代表一行数据注意，该方法不会读取WORD文档中表格里面的图片数据，也不会读取表格之外的数据。
    
    返回:
    
    word文档中所有表格包含的数据集合，按照表格序号值（从1开始计算）为key，表格数据集合为value进行组织
  - getTextData
```
public ArrayList<String> getTextData()
```
    将word文本内容逐段读取，该方法适合小页数范围的word内容获取，大页数范围的word内容获取使用该方法有可能导致内存占用过大
    注意：表格中的每个单元格会被认为是单独一个段落
    
    返回:
    
    按照段落顺序组织的文本内容集合
  - drawTable
```
public void drawTable(Map<String,String> headers,
                      Collection<Map<String,Object>> list,
                      Map<Integer,String> rowColorStyleMap,
                      Map<Integer,Integer> rowHeightStyleMap,
                      Map<Integer,Integer> colWidthStyleMap,
                      Set<String> imageColSet,
                      String pattern)
```
    绘制数据表格
    
    参数:
    
    headers - 表格属性列名数组
    
    list - 需要显示的数据集合，集合中一定要放置符合javabean风格的类的对象。此方法支持的 javabean属性的数据类型有基本数据类型及String,Date,String[],Double[]
    
    rowColorStyleMap - 行的背景颜色风格
    
    rowHeightStyleMap - 行的高度风格
    
    colWidthStyleMap - 列的宽度风格，指定列需要占几个字符宽度
    
    imageColSet - 图片列，以标题为标识
    
    pattern - 如果有时间数据，设定输出格式。默认为"yyyy-MM-dd"
  - addTableRow
```
public void addTableRow(int tableIndex,
                        int rowIndex)
```
    在指定行后面增加行
    
    参数:
    
    tableIndex - 表格索引，从0开始
    
    rowIndex - 行索引，从0开始
  - mergeCell
```
public void mergeCell(int tableIndex,
                      int cellRowFromIndex,
                      int cellColFromIndex,
                      int cellRowToIndex,
                      int cellColToIndex)
```
    合并表格指定区域的单元格
    
    参数:
    
    tableIndex - 表格索引，从0开始
    
    cellRowFromIndex - 起始单元格行索引，从0开始
    
    cellColFromIndex - 起始单元格列索引，从0开始
    
    cellRowToIndex - 目标单元格行索引，从0开始
    
    cellColToIndex - 目标单元格列索引，从0开始
  - getContentFromCell
```
public String getContentFromCell(int tableIndex,
                                 int cellRowIndex,
                                 int cellColIndex)
```
    获取表格指定单元格的文本内容
    
    参数:
    
    tableIndex - 表格索引，从0开始
    
    cellRowIndex - 行索引，从0开始
    
    cellColIndex - 列索引，从0开始
    
    返回:
    
    单元格包含的文本值
  - inputTableCellContent
```
public void inputTableCellContent(int tableIndex,
                                  int cellRowIndex,
                                  int cellColIndex,
                                  String cellValue)
```
    往表格指定单元格设置文本内容
    
    参数:
    
    tableIndex - 表格索引，从0开始
    
    cellRowIndex - 行索引，从0开始
    
    cellColIndex - 列索引，从0开始
    
    cellValue - 文本内容

类 DocumentWrapper

构造器概要

方法概要

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

构造器详细资料

DocumentWrapper

DocumentWrapper

DocumentWrapper

方法详细资料

replaceText

write

render

close

getTableData

getTextData

drawTable

addTableRow

mergeCell

getContentFromCell

inputTableCellContent