Sheet (Excel Write/Read Framework 0.5.2 API)

所有超级接口:

AutoCloseable, Closeable

所有已知实现类:

XMLSheet
```
public interface Sheet
extends Closeable
```
作者:

guanquan.wang at 2019-04-17 11:36

方法概要

所有方法静态方法实例方法抽象方法默认方法已过时的方法
限定符和类型	方法和说明
`org.ttzero.excel.reader.CalcSheet`	`asCalcSheet()` Make worksheets parse formulas
`org.ttzero.excel.reader.MergeSheet`	`asMergeSheet()` Make worksheets copy value on merge cells
`Sheet`	`bind(Class<?> clazz)` Set the binding type
`void`	`close()` Close resource
`static int`	`col2Int(String col)` Convert column mark to int
`Row`	`createRow()` Create a `Row` to read
`Iterator<Row>`	`dataIterator()` Iterating over data rows without header information and blank lines
`default Stream<Row>`	`dataRows()` Return stream with out header row and empty rows
`Dimension`	`getDimension()` Returns The range address of the used area in the current sheet NOTE: This method can only guarantee accurate row ranges
`Row`	`getHeader()` Returns the header of the list.
`int`	`getId()` The worksheet id, it difference with index is that the id will not change because of moving or deleting worksheet.
`int`	`getIndex()` The index of worksheet located at the workbook
`String`	`getName()` The worksheet name
`int`	`getSize()` 已过时。 use `getDimension()` to getting full range address
`boolean`	`isHidden()` Test Worksheet is hidden
`default boolean`	`isShow()` Test Worksheet is show
`Iterator<Row>`	`iterator()` Iterating each row of data contains header information and blank lines
`List<Drawings.Picture>`	`listPictures()` List all pictures in workbook
`Sheet`	`load()` Load the sheet data
`default Sheet`	`reset()` Reset the `Sheet`'s row index to begging
`default Stream<Row>`	`rows()` Return a stream of all rows
`default void`	`saveAsCSV(OutputStream os)` Save file as Comma-Separated Values.
`default void`	`saveAsCSV(Path path)` Save file as Comma-Separated Values.

- 方法详细资料
  - getName
```
String getName()
```
    The worksheet name
    
    返回:
    
    the sheet name
  - getIndex
```
int getIndex()
```
    The index of worksheet located at the workbook
    
    返回:
    
    the index(zero base)
  - getId
```
int getId()
```
    The worksheet id, it difference with index is that the id will not change because of moving or deleting worksheet.
    
    返回:
    
    id of worksheet
  - getSize
```
@Deprecated
int getSize()
```
    已过时。 use getDimension() to getting full range address
    
    size of rows.
    
    返回:
    
    size of rows -1: unknown size
  - getDimension
```
Dimension getDimension()
```
    Returns The range address of the used area in the current sheet
    NOTE: This method can only guarantee accurate row ranges
    
    返回:
    
    worksheet Dimension ranges
  - isHidden
```
boolean isHidden()
```
    Test Worksheet is hidden
    
    返回:
    
    true if current worksheet is hidden
  - isShow
```
default boolean isShow()
```
    Test Worksheet is show
    
    返回:
    
    true if current worksheet is show
  - getHeader
```
Row getHeader()
```
    Returns the header of the list. The first non-empty line defaults to the header information.
    
    返回:
    
    the HeaderRow
  - bind
```
Sheet bind(Class<?> clazz)
```
    Set the binding type
    
    参数:
    
    clazz - the binding type
    
    返回:
    
    the Sheet
  - load
```
Sheet load()
    throws IOException
```
    Load the sheet data
    
    返回:
    
    the Sheet
    
    抛出:
    
    IOException - if I/O error occur
  - iterator
```
Iterator<Row> iterator()
```
    Iterating each row of data contains header information and blank lines
    
    返回:
    
    a row iterator
  - dataIterator
```
Iterator<Row> dataIterator()
```
    Iterating over data rows without header information and blank lines
    
    返回:
    
    a row iterator
  - listPictures
```
List<Drawings.Picture> listPictures()
```
    List all pictures in workbook
    
    返回:
    
    picture list or null if not exists.
  - createRow
```
Row createRow()
```
    Create a Row to read
    
    返回:
    
    subclass
  - reset
```
default Sheet reset()
```
    Reset the Sheet's row index to begging
    
    返回:
    
    the unread Sheet
    
    抛出:
    
    ExcelReadException - if I/O error occur.
    
    UnsupportedOperationException - if sub-class un-implement this function.
  - rows
```
default Stream<Row> rows()
```
    Return a stream of all rows
    
    返回:
    
    a Stream<Row> providing the lines of row described by this Sheet
    
    从以下版本开始:
    
    1.8
  - dataRows
```
default Stream<Row> dataRows()
```
    Return stream with out header row and empty rows
    
    返回:
    
    a Stream<Row> providing the lines of row described by this Sheet
    
    从以下版本开始:
    
    1.8
  - col2Int
```
static int col2Int(String col)
```
    Convert column mark to int
    
    参数:
    
    col - column mark
    
    返回:
    
    int value
  - close
```
void close()
    throws IOException
```
    Close resource
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 Closeable
    
    抛出:
    
    IOException - if I/O error occur
  - saveAsCSV
```
default void saveAsCSV(Path path)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default charset is 'UTF8' and separator character is ','.
    
    参数:
    
    path - the output storage path
    
    抛出:
    
    IOException - if I/O error occur.
  - saveAsCSV
```
default void saveAsCSV(OutputStream os)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default charset is 'UTF8' and separator character is ','.
    
    参数:
    
    os - the output
    
    抛出:
    
    IOException - if I/O error occur.
  - asCalcSheet
```
org.ttzero.excel.reader.CalcSheet asCalcSheet()
```
    Make worksheets parse formulas
    
    返回:
    
    a empty CalcSheet
  - asMergeSheet
```
org.ttzero.excel.reader.MergeSheet asMergeSheet()
```
    Make worksheets copy value on merge cells
    
    返回:
    
    a empty MergeSheet

接口 Sheet

方法概要

方法详细资料

getName

getIndex

getId

getSize

getDimension

isHidden

isShow

getHeader

bind

load

iterator

dataIterator

listPictures

createRow

reset

rows

dataRows

col2Int

close

saveAsCSV

saveAsCSV

asCalcSheet

asMergeSheet