XMLWorksheetWriter (Excel Write/Read Framework 0.5.13 API)

java.lang.Object
- org.ttzero.excel.entity.e7.XMLWorksheetWriter

所有已实现的接口:: Closeable, AutoCloseable, Cloneable, IWorksheetWriter, Storable

@TopNS(prefix={"","r"},
       value="worksheet",
       uri={"http://schemas.openxmlformats.org/spreadsheetml/2006/main","http://schemas.openxmlformats.org/officeDocument/2006/relationships"})
public class XMLWorksheetWriter
extends Object
implements IWorksheetWriter

XML工作表输出

作者:: guanquan.wang at 2019-04-22 16:31

字段概要

字段
限定符和类型	字段和说明
`protected ExtBufferedWriter`	`bw`
`protected Column[]`	`columns`
`protected double[]`	`columnWidths`
`protected Comments`	`comments`
`protected IDrawingsWriter`	`drawingsWriter` Picture and Chart Support
`protected Font[]`	`fs` 按cellXfs下标缓存字体
`protected boolean`	`includeAutoWidth` If there are any auto-width columns
`protected org.slf4j.Logger`	`LOGGER` LOGGER
`protected Path`	`mediaPath`
`protected BiConsumer<Sheet,Integer>`	`progressConsumer` A progress window
`protected Sheet`	`sheet`
`protected int`	`sheetDataReady`
`protected SharedStrings`	`sst`
`protected int`	`startHeaderRow`
`protected int`	`startRow`
`protected Styles`	`styles` 全局样式，为工作表的一个指针
`protected int`	`totalRows`
`protected Path`	`workSheetPath`

构造器概要

构造器
构造器和说明

XMLWorksheetWriter()

XMLWorksheetWriter(Sheet sheet)

构造器
构造器和说明
`XMLWorksheetWriter()`
`XMLWorksheetWriter(Sheet sheet)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`afterSheetData()` Append others customize info
`protected void`	`beforeSheetData(boolean nonHeader)` Begin to write the Sheet data and the header row.
`IWorksheetWriter`	`clone()` 复制工作表输出协议
`void`	`close()` Release resources
`protected void`	`collectHeaderColumns()` 收集表头信息，如果有共享字符串标记则初始化SharedStringsTable
`IDrawingsWriter`	`createDrawingsWriter()` Create drawing writer and add relationship
`protected Picture`	`createPicture(int column, int row)` Picture constructor You can use this method to add general effects
`void`	`downloadCompleted(Picture picture, byte[] body)` Complete downloading, check the file signatures and set the subscript `Picture.idx` to idle
`void`	`downloadRemoteResource(Picture picture, String url)` Download remote resources By default, only HTTP or HTTPS protocols are supported.
`protected Column`	`getColumn(int index)` 获取列属性
`int`	`getColumnLimit()` The Worksheet column limit
`String`	`getFileSuffix()` Returns the worksheet name
`protected Font`	`getFont(int xf)` 通过单元格样式索引获取`FontMetrics`用以计算文本宽度
`double`	`getHeaderHeight(Column[][] columnsArray, int row)` Returns the maximum cell height
`int`	`getRowLimit()` Override this method to modify the maximum number of rows per page, this value contains the header row and data rows eq: limit is 100 means data has 99 rows
`protected boolean`	`hasMedia()` Check if images are output
`protected void`	`initDrawingsWriter()` Initialization DrawingsWriter
`protected Path`	`initWriter(Path root)`
`static boolean`	`isFirstMergedCell(List<Dimension> mergeCells, int row, int col)` Test whether the coordinate is the first cell of the merged cell, and use `Grid.test(int, int)` to determine yes before calling this method
`protected void`	`resizeColumnWidth(File path, int rows)` Resize column width
`IWorksheetWriter`	`setWorksheet(Sheet sheet)` Rest worksheet
`protected int`	`startRow(int rows, int columns, Double rowHeight)` Write begin of row
`protected double`	`stringWidth(String s, int xf)` 计算文本在单元格的宽度，参考`SwingUtilities2.stringWidth(javax.swing.JComponent, java.awt.FontMetrics, java.lang.String)` Java的`FontMetrics`计算中文字符有个问题，对于绝大多数英文字体计算出来的中文字符宽度都不准，在英文字体中显示的中文字体可能会默认显示"宋体"，默认字体与地区和操作系统相关这里只取简体中文的临近值约为字体大小，英文字符计算比较复杂每种字体显示的宽度差异很大，有较窄的字符`'i','l',':'`也有较宽的字符`'X','E','G'，’%'，‘@’`，对于英文字符统一使用`FontMetrics`计算。
`protected void`	`writeAfter(int total)` Write at after worksheet body
`protected void`	`writeBefore()` Write worksheet header data
`protected void`	`writeBinary(byte[] bytes, int row, int column, int xf)` Write binary file
`protected void`	`writeBinary(ByteBuffer byteBuffer, int row, int column, int xf)` Write binary file
`protected void`	`writeBool(boolean bool, int row, int column, int xf)` Write boolean value
`protected void`	`writeChar(char c, int row, int column, int xf)` Write char value
`protected void`	`writeCols(int fillSpace, String defaultWidth)` Write the default column info, The specified column width will be overwritten in these method.
`protected void`	`writeDecimal(BigDecimal bd, int row, int column, int xf)` Write decimal value
`protected void`	`writeDimension()` Write the dimension of sheet, default value is `A1`
`protected void`	`writeDouble(double d, int row, int column, int xf)` Write double value
`protected void`	`writeFile(Path path, int row, int column, int xf)` Write file value
`protected int`	`writeHeaderRow()` Write the header row
`protected void`	`writeMergeCells()` Append merged cells if exists
`protected void`	`writeNull(int row, int column, int xf)` Write blank value
`protected void`	`writeNumeric(long l, int row, int column, int xf)` Write numeric value
`protected void`	`writePictureDirect(int id, String name, int column, int row, FileSignatures.Signature signature)`
`protected void`	`writeRemoteMedia(String url, int row, int column, int xf)` Write remote media value
`protected void`	`writeRootNode()` Write the <worksheet> node
`protected void`	`writeRow(Row row)` Write a row data
`protected void`	`writeRowBlock(RowBlock rowBlock)` Write a row-block
`protected void`	`writeRowBlockFireProgress(RowBlock rowBlock)` Write a row-block and fire progress event
`protected void`	`writeSheetFormat(int fillSpace, String defaultWidth)` Write the sheet format
`protected void`	`writeSheetViews()` Write the sheet views such as FreezeEnum, Default selection cell.
`protected void`	`writeStream(InputStream stream, int row, int column, int xf)` Write stream value
`protected void`	`writeString(String s, int row, int column, int xf)` Write string value
`void`	`writeTo(Path path)` Write a row block
`void`	`writeTo(Path path, Supplier<RowBlock> supplier)` Write a row block
`protected void`	`writeWaterMark()` 添加水印

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

从接口继承的方法 org.ttzero.excel.entity.IWorksheetWriter
isBigDecimal, isBool, isChar, isDate, isDateTime, isDouble, isFloat, isInt, isLocalDate, isLocalDateTime, isLocalTime, isLong, isOutOfSheet, isShort, isString, isTime, writeEmptySheet

- 字段详细资料
  - LOGGER
```
protected final org.slf4j.Logger LOGGER
```
    LOGGER
  - workSheetPath
```
protected Path workSheetPath
```
  - mediaPath
```
protected Path mediaPath
```
  - bw
```
protected ExtBufferedWriter bw
```
  - sheet
```
protected Sheet sheet
```
  - columns
```
protected Column[] columns
```
  - sst
```
protected SharedStrings sst
```
  - styles
```
protected Styles styles
```
    全局样式，为工作表的一个指针
  - comments
```
protected Comments comments
```
  - startRow
```
protected int startRow
```
  - startHeaderRow
```
protected int startHeaderRow
```
  - totalRows
```
protected int totalRows
```
  - sheetDataReady
```
protected int sheetDataReady
```
  - includeAutoWidth
```
protected boolean includeAutoWidth
```
    If there are any auto-width columns
  - drawingsWriter
```
protected IDrawingsWriter drawingsWriter
```
    Picture and Chart Support
  - progressConsumer
```
protected BiConsumer<Sheet,Integer> progressConsumer
```
    A progress window
  - columnWidths
```
protected double[] columnWidths
```
  - fs
```
protected Font[] fs
```
    按cellXfs下标缓存字体
- 构造器详细资料
  - XMLWorksheetWriter
```
public XMLWorksheetWriter()
```
  - XMLWorksheetWriter
```
public XMLWorksheetWriter(Sheet sheet)
```
- 方法详细资料
  - writeTo
```
public void writeTo(Path path,
                    Supplier<RowBlock> supplier)
             throws IOException
```
    Write a row block
    
    指定者:
    
    writeTo 在接口中 IWorksheetWriter
    
    参数:
    
    supplier - a row-block supplier
    
    path - 保存位置
    
    抛出:
    
    IOException - if I/O error occur
  - writeTo
```
public void writeTo(Path path)
             throws IOException
```
    Write a row block
    
    指定者:
    
    writeTo 在接口中 Storable
    
    参数:
    
    path - the storage path
    
    抛出:
    
    IOException - if I/O error occur
  - initWriter
```
protected Path initWriter(Path root)
                   throws IOException
```
    抛出:
    
    IOException
  - setWorksheet
```
public IWorksheetWriter setWorksheet(Sheet sheet)
```
    Rest worksheet
    
    指定者:
    
    setWorksheet 在接口中 IWorksheetWriter
    
    参数:
    
    sheet - the worksheet
    
    返回:
    
    self
  - clone
```
public IWorksheetWriter clone()
```
    从接口复制的说明: IWorksheetWriter
    
    复制工作表输出协议
    
    指定者:
    
    clone 在接口中 IWorksheetWriter
    
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    IWorksheetWriter
  - getFileSuffix
```
public String getFileSuffix()
```
    Returns the worksheet name
    
    指定者:
    
    getFileSuffix 在接口中 IWorksheetWriter
    
    返回:
    
    name of worksheet
  - getRowLimit
```
public int getRowLimit()
```
    Override this method to modify the maximum number of rows per page, this value contains the header row and data rows
    eq: limit is 100 means data has 99 rows
    
    指定者:
    
    getRowLimit 在接口中 IWorksheetWriter
    
    返回:
    
    the row limit
  - getColumnLimit
```
public int getColumnLimit()
```
    The Worksheet column limit
    
    指定者:
    
    getColumnLimit 在接口中 IWorksheetWriter
    
    返回:
    
    the limit
  - writeBefore
```
protected void writeBefore()
                    throws IOException
```
    Write worksheet header data
    
    抛出:
    
    IOException - if I/O error occur
  - writeHeaderRow
```
protected int writeHeaderRow()
                      throws IOException
```
    Write the header row
    
    返回:
    
    row number
    
    抛出:
    
    IOException - if I/O error occur
  - writeAfter
```
protected void writeAfter(int total)
                   throws IOException
```
    Write at after worksheet body
    
    参数:
    
    total - the total of rows
    
    抛出:
    
    IOException - if I/O error occur
  - writeRowBlock
```
protected void writeRowBlock(RowBlock rowBlock)
                      throws IOException
```
    Write a row-block
    
    参数:
    
    rowBlock - the row-block
    
    抛出:
    
    IOException - if I/O error occur.
  - writeRowBlockFireProgress
```
protected void writeRowBlockFireProgress(RowBlock rowBlock)
                                  throws IOException
```
    Write a row-block and fire progress event
    
    参数:
    
    rowBlock - the row-block
    
    抛出:
    
    IOException - if I/O error occur.
  - startRow
```
protected int startRow(int rows,
                       int columns,
                       Double rowHeight)
                throws IOException
```
    Write begin of row
    
    参数:
    
    rows - the row index (zero base)
    
    columns - the column length
    
    rowHeight - the row height
    
    返回:
    
    the row index (one base)
    
    抛出:
    
    IOException - if I/O error occur
  - writeRow
```
protected void writeRow(Row row)
                 throws IOException
```
    Write a row data
    
    参数:
    
    row - a row data
    
    抛出:
    
    IOException - if I/O error occur
  - writeString
```
protected void writeString(String s,
                           int row,
                           int column,
                           int xf)
                    throws IOException
```
    Write string value
    
    参数:
    
    s - the string value
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeDouble
```
protected void writeDouble(double d,
                           int row,
                           int column,
                           int xf)
                    throws IOException
```
    Write double value
    
    参数:
    
    d - the double value
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeDecimal
```
protected void writeDecimal(BigDecimal bd,
                            int row,
                            int column,
                            int xf)
                     throws IOException
```
    Write decimal value
    
    参数:
    
    bd - the decimal value
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeChar
```
protected void writeChar(char c,
                         int row,
                         int column,
                         int xf)
                  throws IOException
```
    Write char value
    
    参数:
    
    c - the character value
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeNumeric
```
protected void writeNumeric(long l,
                            int row,
                            int column,
                            int xf)
                     throws IOException
```
    Write numeric value
    
    参数:
    
    l - the numeric value
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeBool
```
protected void writeBool(boolean bool,
                         int row,
                         int column,
                         int xf)
                  throws IOException
```
    Write boolean value
    
    参数:
    
    bool - the boolean value
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeNull
```
protected void writeNull(int row,
                         int column,
                         int xf)
                  throws IOException
```
    Write blank value
    
    参数:
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeBinary
```
protected void writeBinary(byte[] bytes,
                           int row,
                           int column,
                           int xf)
                    throws IOException
```
    Write binary file
    
    参数:
    
    bytes - the binary data
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeBinary
```
protected void writeBinary(ByteBuffer byteBuffer,
                           int row,
                           int column,
                           int xf)
                    throws IOException
```
    Write binary file
    
    参数:
    
    byteBuffer - the binary data
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeFile
```
protected void writeFile(Path path,
                         int row,
                         int column,
                         int xf)
                  throws IOException
```
    Write file value
    
    参数:
    
    path - the picture file
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeStream
```
protected void writeStream(InputStream stream,
                           int row,
                           int column,
                           int xf)
                    throws IOException
```
    Write stream value
    
    参数:
    
    stream - the picture input-stream
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - writeRemoteMedia
```
protected void writeRemoteMedia(String url,
                                int row,
                                int column,
                                int xf)
                         throws IOException
```
    Write remote media value
    
    参数:
    
    url - remote url
    
    row - the row index
    
    column - the column index
    
    xf - the style index
    
    抛出:
    
    IOException - if I/O error occur
  - resizeColumnWidth
```
protected void resizeColumnWidth(File path,
                                 int rows)
                          throws IOException
```
    Resize column width
    
    参数:
    
    path - the sheet temp path
    
    rows - total of rows
    
    抛出:
    
    IOException - if I/O error occur
  - close
```
public void close()
```
    Release resources
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
  - writeRootNode
```
protected void writeRootNode()
                      throws IOException
```
    Write the <worksheet> node
    
    抛出:
    
    IOException - if I/O error occur.
  - writeDimension
```
protected void writeDimension()
                       throws IOException
```
    Write the dimension of sheet, default value is A1
    
    抛出:
    
    IOException - if I/O error occur.
  - writeSheetViews
```
protected void writeSheetViews()
                        throws IOException
```
    Write the sheet views such as FreezeEnum, Default selection cell.
    
    抛出:
    
    IOException - if I/O error occur.
  - writeSheetFormat
```
protected void writeSheetFormat(int fillSpace,
                                String defaultWidth)
                         throws IOException
```
    Write the sheet format
    
    参数:
    
    fillSpace - The number of characters to pad when recalculating the width.
    
    defaultWidth - The default cell width, 8.38 will be use if it not be setting.
    
    抛出:
    
    IOException - if I/O error occur.
  - writeCols
```
protected void writeCols(int fillSpace,
                         String defaultWidth)
                  throws IOException
```
    Write the default column info, The specified column width will be overwritten in these method.
    
    参数:
    
    fillSpace - The number of characters to pad when recalculating the width.
    
    defaultWidth - The default cell width, 8.38 will be use if it not be setting.
    
    抛出:
    
    IOException - if I/O error occur.
  - beforeSheetData
```
protected void beforeSheetData(boolean nonHeader)
                        throws IOException
```
    Begin to write the Sheet data and the header row.
    
    参数:
    
    nonHeader - mark none header
    
    抛出:
    
    IOException - if I/O error occur.
  - afterSheetData
```
protected void afterSheetData()
                       throws IOException
```
    Append others customize info
    
    抛出:
    
    IOException - if I/O error occur.
  - writeWaterMark
```
protected void writeWaterMark()
                       throws IOException
```
    添加水印
    
    抛出:
    
    IOException - 无权限或磁盘空间不足
  - writeMergeCells
```
protected void writeMergeCells()
                        throws IOException
```
    Append merged cells if exists
    
    抛出:
    
    IOException - if I/O error occur.
  - stringWidth
```
protected double stringWidth(String s,
                             int xf)
```
    计算文本在单元格的宽度，参考SwingUtilities2.stringWidth(javax.swing.JComponent, java.awt.FontMetrics, java.lang.String)
    Java的FontMetrics计算中文字符有个问题，对于绝大多数英文字体计算出来的中文字符宽度都不准，在英文字体中显示的中文字体可能会默认显示"宋体"，默认字体与地区和操作系统相关这里只取简体中文的临近值约为字体大小，英文字符计算比较复杂每种字体显示的宽度差异很大，有较窄的字符'i','l',':'也有较宽的字符'X','E','G'，’%'，‘@’，对于英文字符统一使用FontMetrics计算。
    
    对于自动折行且自适应列宽的单元格则分别计算每一段文本宽度取最大值，这也是为什么不直接调用FontMetrics.stringWidth(java.lang.String) 的原因因为它并不会分段计算
    
    本方法计算的宽度在某些字体下计算出来的结果与实际显示效果可能有很大偏差，此时可以覆写本方法并进行特殊计算
    
    参数:
    
    s - 文本
    
    xf - 单元格样式索引
    
    返回:
    
    文本在excel的宽度
  - isFirstMergedCell
```
public static boolean isFirstMergedCell(List<Dimension> mergeCells,
                                        int row,
                                        int col)
```
    Test whether the coordinate is the first cell of the merged cell, and use Grid.test(int, int) to determine yes before calling this method
    
    参数:
    
    mergeCells - all merged cells
    
    row - the cell row
    
    col - the cell column
    
    返回:
    
    true if the is first cell in merged
  - getHeaderHeight
```
public double getHeaderHeight(Column[][] columnsArray,
                              int row)
```
    Returns the maximum cell height
    
    参数:
    
    columnsArray - the header column array
    
    row - actual rows in Excel
    
    返回:
    
    cell height or -1
  - hasMedia
```
protected boolean hasMedia()
```
    Check if images are output
    
    返回:
    
    true if any column type equals 1
  - initDrawingsWriter
```
protected void initDrawingsWriter()
                           throws IOException
```
    Initialization DrawingsWriter
    
    抛出:
    
    IOException - if I/O error occur
  - createDrawingsWriter
```
public IDrawingsWriter createDrawingsWriter()
```
    Create drawing writer and add relationship
    
    返回:
    
    IDrawingsWriter
  - downloadRemoteResource
```
public void downloadRemoteResource(Picture picture,
                                   String url)
                            throws IOException
```
    Download remote resources By default, only HTTP or HTTPS protocols are supported. Use HttpURLConnection to synchronously download remote resources. For more complex scenarios (asynchronous download, Connection pool, authentication, FTP, etc.), please override this method
    
    参数:
    
    picture - Picture info
    
    url - remote url
    
    抛出:
    
    IOException - if I/O error occur.
  - downloadCompleted
```
public void downloadCompleted(Picture picture,
                              byte[] body)
                       throws IOException
```
    Complete downloading, check the file signatures and set the subscript Picture.idx to idle
    
    参数:
    
    picture - Picture info
    
    body - thr resource data
    
    抛出:
    
    IOException - if I/O error occur.
  - writePictureDirect
```
protected void writePictureDirect(int id,
                                  String name,
                                  int column,
                                  int row,
                                  FileSignatures.Signature signature)
                           throws IOException
```
    抛出:
    
    IOException
  - createPicture
```
protected Picture createPicture(int column,
                                int row)
```
    Picture constructor You can use this method to add general effects
    
    参数:
    
    column - cell column
    
    row - cell row
    
    返回:
    
    Picture
  - collectHeaderColumns
```
protected void collectHeaderColumns()
```
    收集表头信息，如果有共享字符串标记则初始化SharedStringsTable
  - getFont
```
protected Font getFont(int xf)
```
    通过单元格样式索引获取FontMetrics用以计算文本宽度
    
    参数:
    
    xf - 单元格样式索引
    
    返回:
    
    字体度量对象
  - getColumn
```
protected Column getColumn(int index)
```
    获取列属性
    
    参数:
    
    index - 列下标（从0开始）
    
    返回:
    
    列属性（不为null）

类 XMLWorksheetWriter

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.ttzero.excel.entity.IWorksheetWriter

字段详细资料

LOGGER

workSheetPath

mediaPath

bw

sheet

columns

sst

styles

comments

startRow

startHeaderRow

totalRows

sheetDataReady

includeAutoWidth

drawingsWriter

progressConsumer

columnWidths

fs

构造器详细资料

XMLWorksheetWriter

XMLWorksheetWriter

方法详细资料

writeTo

writeTo

initWriter

setWorksheet

clone

getFileSuffix

getRowLimit

getColumnLimit

writeBefore

writeHeaderRow

writeAfter

writeRowBlock

writeRowBlockFireProgress

startRow

writeRow

writeString

writeDouble

writeDecimal

writeChar

writeNumeric

writeBool

writeNull

writeBinary

writeBinary

writeFile

writeStream

writeRemoteMedia

resizeColumnWidth

close

writeRootNode

writeDimension

writeSheetViews

writeSheetFormat

writeCols

beforeSheetData

afterSheetData

writeWaterMark

writeMergeCells

stringWidth

isFirstMergedCell

getHeaderHeight

hasMedia

initDrawingsWriter

createDrawingsWriter

downloadRemoteResource

downloadCompleted

writePictureDirect

createPicture

collectHeaderColumns

getFont

getColumn