XMLWorksheetWriter (Excel Write/Read Framework 0.5.4 API)

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

所有已实现的接口:

Closeable, AutoCloseable, Cloneable, IWorksheetWriter, Storable
```
public class XMLWorksheetWriter
extends Object
implements IWorksheetWriter
```
作者:

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

字段概要

字段
限定符和类型	字段和说明
`protected ExtBufferedWriter`	`bw`
`protected static char[]`	`cacheChar` Char buffer
`protected Column[]`	`columns`
`protected Comments`	`comments`
`protected Sheet`	`sheet`
`protected SharedStrings`	`sst`
`protected int`	`startRow`
`protected Path`	`workSheetPath`

构造器概要

构造器
构造器和说明

XMLWorksheetWriter()

XMLWorksheetWriter(Sheet sheet)

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`afterSheetData()` Append others customize info
`protected void`	`beforeSheetDate(boolean nonHeader)` Begin to write the Sheet data and the header row.
`IWorksheetWriter`	`clone()` Clone
`void`	`close()` Release resources
`int`	`getColumnLimit()` The Worksheet column limit
`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 Path`	`initWriter(Path root)`
`protected void`	`resizeColumnWidth(File path, int rows)` Resize column width
`IWorksheetWriter`	`setWorksheet(Sheet sheet)` Rest worksheet
`protected int`	`startRow(int rows, int columns)` Write begin of row
`protected double`	`stringWidth(String s, int xf)` Calculate text width FIXME reference `SwingUtilities2.stringWidth(javax.swing.JComponent, java.awt.FontMetrics, java.lang.String)`
`protected void`	`writeAfter(int total)` Write at after worksheet body
`protected void`	`writeBefore()` Write worksheet header data
`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`	`writeDecimalAutoSize(BigDecimal bd, int row, int column, int xf)` Write decimal value and cache the max 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`	`writeDoubleAutoSize(double d, int row, int column, int xf)` Write double value and cache the max 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`	`writeNumericAutoSize(long l, int row, int column, int xf)` Write numeric value and cache the max value
`protected void`	`writeRootNode()` Write the <worksheet> node
`protected void`	`writeRow(Row row)` Write a row data
`protected void`	`writeRowAutoSize(Row row)` Write a row data
`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`	`writeString(String s, int row, int column, int xf)` Write string value
`protected void`	`writeStringAutoSize(String s, int row, int column, int xf)` Write string value and cache the max string length
`void`	`writeTo(Path path)` Write a row block
`void`	`writeTo(Path path, Supplier<RowBlock> supplier)` Write a row block

从类继承的方法 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, isShort, isString, isTime, outOfSheet, writeEmptySheet

- 字段详细资料
  - workSheetPath
```
protected Path workSheetPath
```
  - bw
```
protected ExtBufferedWriter bw
```
  - sheet
```
protected Sheet sheet
```
  - columns
```
protected Column[] columns
```
  - sst
```
protected SharedStrings sst
```
  - comments
```
protected Comments comments
```
  - startRow
```
protected int startRow
```
  - cacheChar
```
protected static char[] cacheChar
```
    Char buffer
- 构造器详细资料
  - 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 - the storage 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
    
    指定者:
    
    clone 在接口中 IWorksheetWriter
    
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    IWorksheetWriter
  - 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
  - startRow
```
protected int startRow(int rows,
                       int columns)
                throws IOException
```
    Write begin of row
    
    参数:
    
    rows - the row index (zero base)
    
    columns - the column length
    
    返回:
    
    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
  - writeRowAutoSize
```
protected void writeRowAutoSize(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
  - writeStringAutoSize
```
protected void writeStringAutoSize(String s,
                                   int row,
                                   int column,
                                   int xf)
                            throws IOException
```
    Write string value and cache the max string length
    
    参数:
    
    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
  - writeDoubleAutoSize
```
protected void writeDoubleAutoSize(double d,
                                   int row,
                                   int column,
                                   int xf)
                            throws IOException
```
    Write double value and cache the max 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
  - writeDecimalAutoSize
```
protected void writeDecimalAutoSize(BigDecimal bd,
                                    int row,
                                    int column,
                                    int xf)
                             throws IOException
```
    Write decimal value and cache the max 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
  - writeNumericAutoSize
```
protected void writeNumericAutoSize(long l,
                                    int row,
                                    int column,
                                    int xf)
                             throws IOException
```
    Write numeric value and cache the max 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
  - 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.
  - beforeSheetDate
```
protected void beforeSheetDate(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.
  - 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)
```
    Calculate text width FIXME reference SwingUtilities2.stringWidth(javax.swing.JComponent, java.awt.FontMetrics, java.lang.String)
    
    参数:
    
    s - the string value
    
    xf - the style index
    
    返回:
    
    cell width

类 XMLWorksheetWriter

字段概要

构造器概要

方法概要

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

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

字段详细资料

workSheetPath

bw

sheet

columns

sst

comments

startRow

cacheChar

构造器详细资料

XMLWorksheetWriter

XMLWorksheetWriter

方法详细资料

writeTo

writeTo

initWriter

setWorksheet

clone

getRowLimit

getColumnLimit

writeBefore

writeHeaderRow

writeAfter

startRow

writeRow

writeRowAutoSize

writeString

writeStringAutoSize

writeDouble

writeDoubleAutoSize

writeDecimal

writeDecimalAutoSize

writeChar

writeNumeric

writeNumericAutoSize

writeBool

writeNull

resizeColumnWidth

close

writeRootNode

writeDimension

writeSheetViews

writeSheetFormat

writeCols

beforeSheetDate

afterSheetData

writeMergeCells

stringWidth