Sheet (Excel Write/Read Framework 0.5.2 API)

java.lang.Object
- org.ttzero.excel.entity.Sheet

所有已实现的接口:

Cloneable, Storable

直接已知子类:

CollectionSheet, CSVSheet, EmptySheet, ListSheet, ResultSetSheet
```
@TopNS(prefix={"","r"},
       value="worksheet",
       uri={"http://schemas.openxmlformats.org/spreadsheetml/2006/main","http://schemas.openxmlformats.org/officeDocument/2006/relationships"})
public abstract class Sheet
extends Object
implements Cloneable, Storable
```
Each worksheet corresponds to one or more sheet.xml of physical. When the amount of data exceeds the upper limit of the worksheet, the extra data will be written in the next worksheet page of the current position, with the name of the parent worksheet. After adding "(1,2,3...n)" as the name of the copied sheet, the pagination is automatic without additional settings.
Usually worksheetWriter calls the nextBlock() method to load a row-block for writing. When the row-block returns the flag EOF, mean is the current worksheet finished written, and the next worksheet is written.
Extends the existing worksheet to implement a custom data source worksheet. The data source can be micro-services, Mybatis, JPA or any others. If the data source returns an array of json objects, please convert to an object ArrayList or Map ArrayList, the object ArrayList needs to extends ListSheet, the Map ArrayList needs to extends ListMapSheet and implement the ListSheet.more() method.
If other formats cannot be converted to ArrayList, you need to inherit from the base class Sheet and implement the resetBlockData() and getHeaderColumns() methods.

作者:

guanquan.wang on 2017/9/26.

另请参阅:

ListSheet, ListMapSheet, ResultSetSheet, StatementSheet, CSVSheet

嵌套类概要

嵌套类
限定符和类型类和说明

static class Sheet.Column
已过时。
use the new Column

嵌套类
限定符和类型	类和说明
`static class`	`Sheet.Column` 已过时。 use the new `Column`

字段概要

字段
限定符和类型	字段和说明
`protected int`	`autoOdd` Automatic interlacing color
`protected int`	`autoSize` To mark the cell auto-width
`protected ICellValueAndStyle`	`cellValueAndStyle`
`protected Column[]`	`columns`
`protected Comments`	`comments` The header column comments
`protected int`	`copyCount`
`protected boolean`	`copySheet` A copy worksheet flag
`protected Map<String,Object>`	`extProp` Other extend properties
`protected int`	`extPropMark` The bit flag of the extended parameter.
`protected int`	`forceExport` Force export all attributes
`protected boolean`	`headerReady` To mark the header column is ready
`protected int`	`headStyle` The header style value
`protected int`	`headStyleIndex` The header style index
`protected boolean`	`hidden` Mark the cell is hidden
`protected int`	`id`
`protected org.slf4j.Logger`	`LOGGER`
`protected String`	`name`
`protected int`	`nonHeader` Ignore header when export
`protected int`	`oddFill` Odd row's background color
`protected RelManager`	`relManager`
`protected RowBlock`	`rowBlock`
`protected int`	`rows` The row number
`protected IWorksheetWriter`	`sheetWriter`
`protected boolean`	`shouldClose` Close resource on the last copy worksheet
`protected WaterMark`	`waterMark`
`protected double`	`width` The default cell width
`protected Workbook`	`workbook`

构造器概要

构造器
构造器和说明
`Sheet()`
`Sheet(String name)` Constructor worksheet
`Sheet(String name, Column... columns)` Constructor worksheet
`Sheet(String name, WaterMark waterMark, Column... columns)` Constructor worksheet

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`Sheet`	`addRel(Relationship rel)` Add relationship
`void`	`afterSheetAccess(Path workSheetPath)` Write some final info
`Sheet`	`autoSize()` Setting auto resize cell's width
`int`	`buildHeadStyle(String fontColor, String fillBgColor)` Custom header style according to parameters
`Sheet`	`cancelForceExport()` Cancel force export
`Sheet`	`cancelOddStyle()` Cancel the odd row's fill style
`void`	`checkColumnLimit()` Check the limit of columns
`Sheet`	`clone()`
`void`	`close()` abstract method close
`Comments`	`createComments()` Create a `Comments` and add relationship
`int`	`defaultHeadStyle()` Build default header style
`int`	`defaultHeadStyleIndex()` Build default header style
`Relationship`	`findRel(String key)`
`Sheet`	`fixSize()` Setting fix column width
`Sheet`	`fixSize(double width)` Setting fix column width
`Sheet`	`forceExport()` Force export of attributes without `ExcelColumn` annotations
`Column[]`	`getAndSortHeaderColumns()` Sort column by `colIndex`
`int`	`getAutoOdd()` Returns auto setting odd background flag
`int`	`getAutoSize()` Returns the re-size setting
`Comments`	`getComments()` Returns the header column `Comments`
`protected String`	`getCopySheetName()` Returns the copy worksheet name
`double`	`getDefaultWidth()` Return the cell default width
`Map<String,Object>`	`getExtPropAsMap()` Shallow copy all extend properties
`Object`	`getExtPropValue(String key)` Returns the value to which the specified key in extend property, or `null` if it contains no mapping for the key.
`String`	`getFileName()` Returns the worksheet name
`int`	`getForceExport()` Returns the force export
`protected Column[]`	`getHeaderColumns()` Returns the header column info The copy sheet will use the parent worksheet header information.
`int`	`getHeadStyle()` Returns the header style value
`int`	`getHeadStyleIndex()` Returns the header style index
`int`	`getId()`
`String`	`getName()` Returns the worksheet name
`int`	`getNonHeader()` Returns the nonHeader value.
`int`	`getOddFill()` Returns the odd columns fill style
`int`	`getRowBlockSize()` The worksheet is written by units of row-block.
`protected int`	`getRowLimit()` The Worksheet row limit
`SharedStrings`	`getSst()` Returns shared string
`WaterMark`	`getWaterMark()` Returns the `WaterMark`
`Workbook`	`getWorkbook()` Returns workbook
`boolean`	`hasHeaderColumns()` Check the header information is exist
`Sheet`	`hidden()` Setting the worksheet status
`Sheet`	`ignoreHeader()` Settings nonHeader property
`static char[]`	`int2Col(int n)` Int conversion to column string number.
`boolean`	`isAutoSize()` Test is auto size column width
`boolean`	`isHidden()` Returns the worksheet is hidden
`protected void`	`markExtProp()` Mark ext-properties bit
`RowBlock`	`nextBlock()` Returns a row-block.
`protected static boolean`	`nonOrIntDefault(int style)`
`protected void`	`paging()` Split worksheet data
`Sheet`	`putAllExtProp(Map<String,Object> m)` Copies all of the mappings from the specified map to extend properties
`Sheet`	`putExtProp(String key, Object value)` Append extend property
`Sheet`	`putExtPropIfAbsent(String key, Object value)` If the specified key is not already associated with a value (or is mapped to `null`) associates it with the given value and returns `null`, else returns the current value.
`protected abstract void`	`resetBlockData()` Each row-block is multiplexed and will be called to reset the data when a row-block is completely written.
`protected void`	`resetCommonProperties(Column[] columns)`
`protected int`	`search(Column[] columns, int n, int k)`
`Sheet`	`setAutoOdd(int autoOdd)` Setting auto setting odd background flag
`void`	`setCellValueAndStyle(ICellValueAndStyle cellValueAndStyle)`
`Sheet`	`setColumns(Column[] columns)` Setting the header rows's columns
`Sheet`	`setHeadStyle(Font font, Fill fill, Border border)` Setting the header column styles
`Sheet`	`setHeadStyle(Font font, Fill fill, Border border, int vertical, int horizontal)` Setting the header column styles
`Sheet`	`setHeadStyle(int style)` Setting the header cell styles
`Sheet`	`setHeadStyle(NumFmt numFmt, Font font, Fill fill, Border border, int vertical, int horizontal)` Setting the header column styles
`Sheet`	`setHeadStyleIndex(int styleIndex)` Setting the header cell styles
`void`	`setId(int id)`
`Sheet`	`setName(String name)` Setting the worksheet name
`Sheet`	`setOddFill(Fill fill)` Setting the odd row's fill style
`void`	`setSheetWriter(IWorksheetWriter sheetWriter)`
`Sheet`	`setWaterMark(WaterMark waterMark)` Setting the `WaterMark`
`Sheet`	`setWorkbook(Workbook workbook)` Setting the workbook
`int`	`size()` Returns total rows in this worksheet
`protected void`	`sortColumns(Column[] columns)`
`void`	`what(String code)` Output the export detail info
`void`	`what(String code, String... args)` Output export detail info
`void`	`writeTo(Path path)` Write worksheet data to path

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

- 字段详细资料
  - LOGGER
```
protected final org.slf4j.Logger LOGGER
```
  - workbook
```
protected Workbook workbook
```
  - name
```
protected String name
```
  - columns
```
protected Column[] columns
```
  - waterMark
```
protected WaterMark waterMark
```
  - relManager
```
protected RelManager relManager
```
  - id
```
protected int id
```
  - comments
```
protected Comments comments
```
    The header column comments
  - autoSize
```
protected int autoSize
```
    To mark the cell auto-width
  - width
```
protected double width
```
    The default cell width
  - rows
```
protected int rows
```
    The row number
  - hidden
```
protected boolean hidden
```
    Mark the cell is hidden
  - headStyleIndex
```
protected int headStyleIndex
```
    The header style index
  - headStyle
```
protected int headStyle
```
    The header style value
  - autoOdd
```
protected int autoOdd
```
    Automatic interlacing color
  - oddFill
```
protected int oddFill
```
    Odd row's background color
  - copySheet
```
protected boolean copySheet
```
    A copy worksheet flag
  - copyCount
```
protected int copyCount
```
  - rowBlock
```
protected RowBlock rowBlock
```
  - sheetWriter
```
protected IWorksheetWriter sheetWriter
```
  - headerReady
```
protected boolean headerReady
```
    To mark the header column is ready
  - shouldClose
```
protected boolean shouldClose
```
    Close resource on the last copy worksheet
  - cellValueAndStyle
```
protected ICellValueAndStyle cellValueAndStyle
```
  - forceExport
```
protected int forceExport
```
    Force export all attributes
  - nonHeader
```
protected int nonHeader
```
    Ignore header when export
  - extProp
```
protected Map<String,Object> extProp
```
    Other extend properties
  - extPropMark
```
protected int extPropMark
```
    The bit flag of the extended parameter. If there is an extended parameter, the corresponding bit is 1. The lower 16 bits are occupied by the system, and the upper 16 bits can be extended by themselves.
- 构造器详细资料
  - Sheet
```
public Sheet()
```
  - Sheet
```
public Sheet(String name)
```
    Constructor worksheet
    
    参数:
    
    name - the worksheet name
  - Sheet
```
public Sheet(String name,
             Column... columns)
```
    Constructor worksheet
    
    参数:
    
    name - the worksheet name
    
    columns - the header info
  - Sheet
```
public Sheet(String name,
             WaterMark waterMark,
             Column... columns)
```
    Constructor worksheet
    
    参数:
    
    name - the worksheet name
    
    waterMark - the water mark
    
    columns - the header info
- 方法详细资料
  - getId
```
public int getId()
```
  - setId
```
public void setId(int id)
```
  - setSheetWriter
```
public void setSheetWriter(IWorksheetWriter sheetWriter)
```
  - setCellValueAndStyle
```
public void setCellValueAndStyle(ICellValueAndStyle cellValueAndStyle)
```
  - getWorkbook
```
public Workbook getWorkbook()
```
    Returns workbook
    
    返回:
    
    current Workbook
  - setWorkbook
```
public Sheet setWorkbook(Workbook workbook)
```
    Setting the workbook
    
    参数:
    
    workbook - the Workbook
    
    返回:
    
    current Sheet
  - what
```
public void what(String code)
```
    Output the export detail info
    
    参数:
    
    code - the message code in message properties file
  - what
```
public void what(String code,
                 String... args)
```
    Output export detail info
    
    参数:
    
    code - the message code in message properties file
    
    args - the placeholder values
  - getSst
```
public SharedStrings getSst()
```
    Returns shared string
    
    返回:
    
    global SharedStrings in workbook
  - getDefaultWidth
```
public double getDefaultWidth()
```
    Return the cell default width
    
    返回:
    
    the width value
  - autoSize
```
public Sheet autoSize()
```
    Setting auto resize cell's width
    
    返回:
    
    current Sheet
  - fixSize
```
public Sheet fixSize()
```
    Setting fix column width
    
    返回:
    
    current Sheet
  - fixSize
```
public Sheet fixSize(double width)
```
    Setting fix column width
    
    参数:
    
    width - the column width
    
    返回:
    
    current Sheet
  - getAutoSize
```
public int getAutoSize()
```
    Returns the re-size setting
    
    返回:
    
    1: auto-size 2:fix-size
  - isAutoSize
```
public boolean isAutoSize()
```
    Test is auto size column width
    
    返回:
    
    true if auto-size
  - cancelOddStyle
```
public Sheet cancelOddStyle()
```
    Cancel the odd row's fill style
    
    返回:
    
    current Sheet
  - getAutoOdd
```
public int getAutoOdd()
```
    Returns auto setting odd background flag
    
    返回:
    
    1: auto setting, others none
  - setAutoOdd
```
public Sheet setAutoOdd(int autoOdd)
```
    Setting auto setting odd background flag
    
    参数:
    
    autoOdd - 1: setting, others none
    
    返回:
    
    current Sheet
  - setOddFill
```
public Sheet setOddFill(Fill fill)
```
    Setting the odd row's fill style
    
    参数:
    
    fill - the fill style
    
    返回:
    
    current Sheet
  - getOddFill
```
public int getOddFill()
```
    Returns the odd columns fill style
    
    返回:
    
    the fill style value
  - getName
```
public String getName()
```
    Returns the worksheet name
    
    返回:
    
    the worksheet name
  - setName
```
public Sheet setName(String name)
```
    Setting the worksheet name
    
    参数:
    
    name - the worksheet name
    
    返回:
    
    current Sheet
  - getComments
```
public Comments getComments()
```
    Returns the header column Comments
    
    返回:
    
    Columns instance if exists
  - createComments
```
public Comments createComments()
```
    Create a Comments and add relationship
    
    返回:
    
    a comment instance
  - getHeaderColumns
```
protected Column[] getHeaderColumns()
```
    Returns the header column info
    The copy sheet will use the parent worksheet header information.
    Use the method getAndSortHeaderColumns() to get Columns
    
    返回:
    
    array of column
  - getAndSortHeaderColumns
```
public Column[] getAndSortHeaderColumns()
```
    Sort column by colIndex
    
    返回:
    
    header columns
  - resetCommonProperties
```
protected void resetCommonProperties(Column[] columns)
```
  - sortColumns
```
protected void sortColumns(Column[] columns)
```
  - search
```
protected int search(Column[] columns,
                     int n,
                     int k)
```
  - setColumns
```
public Sheet setColumns(Column[] columns)
```
    Setting the header rows's columns
    
    参数:
    
    columns - the header row's columns
    
    返回:
    
    current Sheet
  - getWaterMark
```
public WaterMark getWaterMark()
```
    Returns the WaterMark
    
    返回:
    
    the WaterMark in worksheet
    
    另请参阅:
    
    WaterMark
  - setWaterMark
```
public Sheet setWaterMark(WaterMark waterMark)
```
    Setting the WaterMark
    
    参数:
    
    waterMark - the WaterMark
    
    返回:
    
    current Sheet
  - isHidden
```
public boolean isHidden()
```
    Returns the worksheet is hidden
    
    返回:
    
    true: hidden, false: not hidden
  - hidden
```
public Sheet hidden()
```
    Setting the worksheet status
    
    返回:
    
    current Sheet
  - forceExport
```
public Sheet forceExport()
```
    Force export of attributes without ExcelColumn annotations
    
    返回:
    
    current Sheet
  - cancelForceExport
```
public Sheet cancelForceExport()
```
    Cancel force export
    
    返回:
    
    current Sheet
  - getForceExport
```
public int getForceExport()
```
    Returns the force export
    
    返回:
    
    1 if force, otherwise returns 0
  - close
```
public void close()
           throws IOException
```
    abstract method close
    
    抛出:
    
    IOException - if I/O error occur
  - writeTo
```
public void writeTo(Path path)
             throws IOException
```
    Write worksheet data to path
    
    指定者:
    
    writeTo 在接口中 Storable
    
    参数:
    
    path - the storage path
    
    抛出:
    
    IOException - if I/O error occur
  - paging
```
protected void paging()
```
    Split worksheet data
  - addRel
```
public Sheet addRel(Relationship rel)
```
    Add relationship
    
    参数:
    
    rel - Relationship
    
    返回:
    
    current worksheet
  - findRel
```
public Relationship findRel(String key)
```
  - getFileName
```
public String getFileName()
```
    Returns the worksheet name
    
    返回:
    
    name of worksheet
  - setHeadStyle
```
public Sheet setHeadStyle(Font font,
                          Fill fill,
                          Border border)
```
    Setting the header column styles
    
    参数:
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    返回:
    
    current Sheet
  - setHeadStyle
```
public Sheet setHeadStyle(Font font,
                          Fill fill,
                          Border border,
                          int vertical,
                          int horizontal)
```
    Setting the header column styles
    
    参数:
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    vertical - the vertical style
    
    horizontal - the horizontal style
    
    返回:
    
    current Sheet
  - setHeadStyle
```
public Sheet setHeadStyle(NumFmt numFmt,
                          Font font,
                          Fill fill,
                          Border border,
                          int vertical,
                          int horizontal)
```
    Setting the header column styles
    
    参数:
    
    numFmt - the number format
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    vertical - the vertical style
    
    horizontal - the horizontal style
    
    返回:
    
    current Sheet
  - setHeadStyle
```
public Sheet setHeadStyle(int style)
```
    Setting the header cell styles
    
    参数:
    
    style - the styles value
    
    返回:
    
    current Sheet
  - setHeadStyleIndex
```
public Sheet setHeadStyleIndex(int styleIndex)
```
    Setting the header cell styles
    
    参数:
    
    styleIndex - the styles index
    
    返回:
    
    current Sheet
  - getHeadStyle
```
public int getHeadStyle()
```
    Returns the header style value
    
    返回:
    
    0 if not set
  - getHeadStyleIndex
```
public int getHeadStyleIndex()
```
    Returns the header style index
    
    返回:
    
    -1 if not set
  - buildHeadStyle
```
public int buildHeadStyle(String fontColor,
                          String fillBgColor)
```
    Custom header style according to parameters
    
    参数:
    
    fontColor - the font color
    
    fillBgColor - the fill background color
    
    返回:
    
    style value
  - defaultHeadStyle
```
public int defaultHeadStyle()
```
    Build default header style
    
    返回:
    
    style value
  - defaultHeadStyleIndex
```
public int defaultHeadStyleIndex()
```
    Build default header style
    
    返回:
    
    style index
  - nonOrIntDefault
```
protected static boolean nonOrIntDefault(int style)
```
  - size
```
public int size()
```
    Returns total rows in this worksheet
    
    返回:
    
    -1 if unknown or uncertain
  - nextBlock
```
public RowBlock nextBlock()
```
    Returns a row-block. The row-block is content by 32 rows
    
    返回:
    
    a row-block
  - getRowBlockSize
```
public int getRowBlockSize()
```
    The worksheet is written by units of row-block. The default size of a row-block is 32, which means that 32 rows of data are written at a time. If the data is not enough, the more() method will be called to get more data.
    
    返回:
    
    the row-block size
  - afterSheetAccess
```
public void afterSheetAccess(Path workSheetPath)
                      throws IOException
```
    Write some final info
    
    参数:
    
    workSheetPath - the worksheet path
    
    抛出:
    
    IOException - if I/O error occur
  - getCopySheetName
```
protected String getCopySheetName()
```
    Returns the copy worksheet name
    
    返回:
    
    the name of copy worksheet
  - clone
```
public Sheet clone()
```
    覆盖:
    
    clone 在类中 Object
  - checkColumnLimit
```
public void checkColumnLimit()
```
    Check the limit of columns
  - hasHeaderColumns
```
public boolean hasHeaderColumns()
```
    Check the header information is exist
    
    返回:
    
    true if exist
  - int2Col
```
public static char[] int2Col(int n)
```
    Int conversion to column string number. The max column on sheet is 16_384 after office 2007 and 256 in office 2003
    int | column number -------|--------- 1 | A 10 | J 26 | Z 27 | AA 28 | AB 53 | BA 16_384 | XFD
    参数:
    
    n - the column number
    
    返回:
    
    column string
  - ignoreHeader
```
public Sheet ignoreHeader()
```
    Settings nonHeader property
    
    返回:
    
    current Worksheet
  - getNonHeader
```
public int getNonHeader()
```
    Returns the nonHeader value.
    
    返回:
    
    -1, 0, 1 means not-set, include header, exclude header
  - getRowLimit
```
protected int getRowLimit()
```
    The Worksheet row limit
    
    返回:
    
    the limit
  - putExtProp
```
public Sheet putExtProp(String key,
                        Object value)
```
    Append extend property
    
    参数:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    返回:
    
    current Worksheet
  - putExtPropIfAbsent
```
public Sheet putExtPropIfAbsent(String key,
                                Object value)
```
    If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.
    
    参数:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    返回:
    
    current Worksheet
  - putAllExtProp
```
public Sheet putAllExtProp(Map<String,Object> m)
```
    Copies all of the mappings from the specified map to extend properties
    
    参数:
    
    m - mappings to be stored in this map
    
    返回:
    
    current Worksheet
  - getExtPropValue
```
public Object getExtPropValue(String key)
```
    Returns the value to which the specified key in extend property, or null if it contains no mapping for the key.
    
    参数:
    
    key - the key whose associated value is to be returned
    
    返回:
    
    the extend property value
  - getExtPropAsMap
```
public Map<String,Object> getExtPropAsMap()
```
    Shallow copy all extend properties
    
    返回:
    
    all extend properties
  - markExtProp
```
protected void markExtProp()
```
    Mark ext-properties bit
  - resetBlockData
```
protected abstract void resetBlockData()
```
    Each row-block is multiplexed and will be called to reset the data when a row-block is completely written. Call the getRowBlockSize() method to get the row-block size, call the ICellValueAndStyle.reset(int, Cell, Object, org.ttzero.excel.entity.Column) method to set value and styles.

类 Sheet

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

LOGGER

workbook

name

columns

waterMark

relManager

id

comments

autoSize

width

rows

hidden

headStyleIndex

headStyle

autoOdd

oddFill

copySheet

copyCount

rowBlock

sheetWriter

headerReady

shouldClose

cellValueAndStyle

forceExport

nonHeader

extProp

extPropMark

构造器详细资料

Sheet

Sheet

Sheet

Sheet

方法详细资料

getId

setId

setSheetWriter

setCellValueAndStyle

getWorkbook

setWorkbook

what

what

getSst

getDefaultWidth

autoSize

fixSize

fixSize

getAutoSize

isAutoSize

cancelOddStyle

getAutoOdd

setAutoOdd

setOddFill

getOddFill

getName

setName

getComments

createComments

getHeaderColumns

getAndSortHeaderColumns

resetCommonProperties

sortColumns

search

setColumns

getWaterMark

setWaterMark

isHidden

hidden

forceExport

cancelForceExport

getForceExport

close

writeTo

paging