SimpleSheet (Excel Write/Read Framework 0.5.25 API)

java.lang.Object
- org.ttzero.excel.entity.Sheet
- - org.ttzero.excel.entity.ListSheet<T>
  - - org.ttzero.excel.entity.SimpleSheet<T>

所有已实现的接口:

Cloneable, Storable
```
public class SimpleSheet<T>
extends ListSheet<T>
```
简单工作表，它的简单之处在于只需要指定单元格的值即可输出，不需要再定义对象也不受@ExcelColumn注解影响例如Arrays.asList(1, 2, 3)则会将数字1,2,3输出到第一行的A,B,C三列。
简单工作表支持传入List或Array，但两种类型不能掺杂使用，要么全是List 要么全是Array，导出过程中并不会逐一判断泛型的实际类型，所以需要在外部做好约束。由于没有表头做为限制所以每一行的数组长度并不要求一致数据类型也不要求一致但最长不能超过Excel限制的长度，除日期类型外每个单元格均保持"常规"格式，日期类型默认添加格式化。 SimpleSheet继承于ListSheet如果传入数据为普通数组对象则将使用ListSheet进行处理。

默认情况下简单工作表将不会设置样式(包括表头样式)，SimpleSheet提供简化的setHeader(List)方法来指定表头，也可以使用firstRowAsHeader方法将第一行数据做为表头，当指定表头时依然会保持通用样式。
```
 new Workbook()
     .addSheet(new SimpleSheet<>()
          // 导出两行数据
         .setData(Arrays.asList(new String[]{"a","b","c"}, new int[]{1,2,3,4,5}))
     ).writeTo(Paths.get("f://abc.xlsx"));
```
从以下版本开始:

2024-09-24

作者:

guanquan.wang

另请参阅:

ListSheet

嵌套类概要
- 从类继承的嵌套类/接口 org.ttzero.excel.entity.ListSheet
  ListSheet.EntryColumn

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`firstRowAsHeader` 将第一行数据作为表头
`protected int`	`type` 0: empty 1: List 2: Array 3: Super(not a type)
`protected static Column`	`UNALLOCATED_COLUMN` 未实例化的列，可用于在写超出预知范围外的列

从类继承的字段 org.ttzero.excel.entity.ListSheet
data, dataSupplier, end, eof, forceExport, start, styleProcessor, tClazz

从类继承的字段 org.ttzero.excel.entity.Sheet
autoSize, cellValueAndStyle, columns, comments, copyCount, copySheet, extProp, extPropMark, headerReady, headerRowHeight, headStyle, headStyleIndex, hidden, id, LOGGER, name, nonHeader, progressConsumer, relManager, rowBlock, rowHeight, rows, sheetWriter, shouldClose, showGridLines, startCoordinate, watermark, width, workbook, zebraFill, zebraFillStyle

构造器概要

构造器
构造器和说明
`SimpleSheet()` 实例化工作表，未指定工作表名称时默认以`'Sheet'+id`命名
`SimpleSheet(Column... columns)` 实例化工作表并指定表头信息
`SimpleSheet(List<T> data)` 实例化工作表并指定初始数据
`SimpleSheet(List<T> data, Column... columns)` 实例化工作表并指定初始数据和表头
`SimpleSheet(List<T> data, Watermark watermark, Column... columns)` 已过时。使用场景极少，后续版本将删除
`SimpleSheet(String name)` 实例化工作表并指定工作表名称
`SimpleSheet(String name, Column... columns)` 实例化工作表并指定工作表名称和表头信息
`SimpleSheet(String name, List<T> data)` 实例化工作表并指定工作表名称和初始数据
`SimpleSheet(String name, List<T> data, Column... columns)` 实例化工作表并指定工作表名称、初始数据和表头
`SimpleSheet(String name, List<T> data, Watermark watermark, Column... columns)` 已过时。使用场景极少，后续版本将删除
`SimpleSheet(String name, Watermark watermark, Column... columns)` 已过时。使用场景极少，后续版本将删除

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected static void`	`datetimeCell(Styles styles, Cell cell)` 日期类型添加默认format
`static void`	`defaultDatetimeCell(Styles styles, Cell cell)` 日期类型添加默认format
`SimpleSheet<T>`	`firstRowAsHeader()` 将第一行数据作为表头
`double`	`getDefaultWidth()` 获取默认列宽，如果未在Column上特殊指定宽度时该宽度将应用于每一列
`Column[]`	`getHeaderColumns()` 获取表头信息，未实例化表头时会执行初始化方法实例化表头对于简单类型来说表头信息并无任何有效信息，
`RowBlock`	`nextBlock()` 获取下一段`RowBlock`行块数据，工作表输出协议通过此方法循环获取行数据并落盘，行块被设计为一个滑行窗口，下游输出协议只能获取一个窗口的数据默认包含32行。
`protected void`	`resetBlockData()` 重置`RowBlock`行块数据
`SimpleSheet<T>`	`setHeader(List<String> header)` 设置表头信息，与Columns不同的是本方法只设置表头值并不带任何其它属性，可以看为`Sheet.setColumns(List)`的简化方法
`SimpleSheet<T>`	`setHeader(String... header)` 设置表头信息，与Columns不同的是本方法只设置表头值并不带任何其它属性，可以看为`Sheet.setColumns(Column...)`的简化方法

从类继承的方法 org.ttzero.excel.entity.ListSheet
append, attachFreezePanes, attachOtherColumn, buildHeaderComment, buildHeaderStyle, cancelForceExport, close, createColumn, createColumnByAnnotation, dataSize, filterOthersMethodsCanExport, forceExport, getDesignStyle, getDesignStyle, getDesignStyle, getEndIndex, getFirst, getForceExport, getStyleProcessor, getTClass, ignoreColumn, init, left, mergeGlobalSetting, more, paging, setClass, setData, setData, setStyleProcessor

从类继承的方法 org.ttzero.excel.entity.Sheet
addRel, afterSheetAccess, afterSheetDataWriter, autoSize, buildHeadStyle, calculateRealColIndex, cancelZebraLine, checkColumnLimit, clone, createComments, defaultHeadStyle, defaultHeadStyleIndex, defaultZebraLine, findRel, fixedSize, fixedSize, getAndSortHeaderColumns, getAutoSize, getCellValueAndStyle, getColumns, getComments, getCopySheetName, getExtPropAsMap, getExtPropValue, getFileName, getHeaderRowHeight, getHeadStyle, getHeadStyleIndex, getId, getName, getNonHeader, getProgressConsumer, getRelManager, getRowBlockSize, getRowHeight, getRowLimit, getSheetWriter, getStartColNum, getStartRowIndex, getStartRowNum, getWatermark, getWaterMark, getWorkbook, getZebraFill, getZebraFillStyle, hasHeaderColumns, hidden, hideGridLines, ignoreHeader, insert, int2Col, isAutoSize, isHidden, isScrollToVisibleArea, isShowGridLines, markExtProp, mergeHeaderCellsIfEquals, onProgress, putAllExtProp, putExtProp, putExtPropIfAbsent, resetCommonProperties, reverseHeadColumn, search, setCellValueAndStyle, setColumns, setColumns, setHeaderRowHeight, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyleIndex, setId, setName, setRowHeight, setSheetWriter, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartRowIndex, setStartRowIndex, setWatermark, setWaterMark, setWorkbook, setZebraLine, showGridLines, size, sortColumns, toCoordinate, writeTo

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

- 字段详细资料
  - type
```
protected int type
```
    0: empty 1: List 2: Array 3: Super(not a type)
  - firstRowAsHeader
```
protected boolean firstRowAsHeader
```
    将第一行数据作为表头
  - UNALLOCATED_COLUMN
```
protected static final Column UNALLOCATED_COLUMN
```
    未实例化的列，可用于在写超出预知范围外的列
- 构造器详细资料
  - SimpleSheet
```
public SimpleSheet()
```
    实例化工作表，未指定工作表名称时默认以'Sheet'+id命名
  - SimpleSheet
```
public SimpleSheet(String name)
```
    实例化工作表并指定工作表名称
    
    参数:
    
    name - 工作表名称
  - SimpleSheet
```
public SimpleSheet(Column... columns)
```
    实例化工作表并指定表头信息
    
    参数:
    
    columns - 表头信息
  - SimpleSheet
```
public SimpleSheet(String name,
                   Column... columns)
```
    实例化工作表并指定工作表名称和表头信息
    
    参数:
    
    name - 工作表名称
    
    columns - 表头信息
  - SimpleSheet
```
@Deprecated
public SimpleSheet(String name,
                               Watermark watermark,
                               Column... columns)
```
    已过时。使用场景极少，后续版本将删除
    
    实例化工作表并指定工作表名称，水印和表头信息
    
    参数:
    
    name - 工作表名称
    
    watermark - 水印
    
    columns - 表头信息
  - SimpleSheet
```
public SimpleSheet(List<T> data)
```
    实例化工作表并指定初始数据
    
    参数:
    
    data - 初始数据
  - SimpleSheet
```
public SimpleSheet(String name,
                   List<T> data)
```
    实例化工作表并指定工作表名称和初始数据
    
    参数:
    
    name - 工作表名称
    
    data - 初始数据
  - SimpleSheet
```
public SimpleSheet(List<T> data,
                   Column... columns)
```
    实例化工作表并指定初始数据和表头
    
    参数:
    
    data - 初始数据
    
    columns - 表头信息
  - SimpleSheet
```
public SimpleSheet(String name,
                   List<T> data,
                   Column... columns)
```
    实例化工作表并指定工作表名称、初始数据和表头
    
    参数:
    
    name - 工作表名称
    
    data - 初始数据
    
    columns - 表头信息
  - SimpleSheet
```
@Deprecated
public SimpleSheet(List<T> data,
                               Watermark watermark,
                               Column... columns)
```
    已过时。使用场景极少，后续版本将删除
    
    实例化工作表并指定初始数据、水印和表头
    
    参数:
    
    data - 初始数据
    
    watermark - 水印
    
    columns - 表头信息
  - SimpleSheet
```
@Deprecated
public SimpleSheet(String name,
                               List<T> data,
                               Watermark watermark,
                               Column... columns)
```
    已过时。使用场景极少，后续版本将删除
    
    实例化工作表并指定工作表名称、初始数据、水印和表头
    
    参数:
    
    name - 工作表名称
    
    data - 初始数据
    
    watermark - 水印
    
    columns - 表头信息
- 方法详细资料
  - setHeader
```
public SimpleSheet<T> setHeader(List<String> header)
```
    设置表头信息，与Columns不同的是本方法只设置表头值并不带任何其它属性，可以看为Sheet.setColumns(List)的简化方法
    
    参数:
    
    header - 表头信息列表
    
    返回:
    
    当前对象，支持链式调用
  - setHeader
```
public SimpleSheet<T> setHeader(String... header)
```
    设置表头信息，与Columns不同的是本方法只设置表头值并不带任何其它属性，可以看为Sheet.setColumns(Column...)的简化方法
    
    参数:
    
    header - 表头信息列表
    
    返回:
    
    当前对象，支持链式调用
  - firstRowAsHeader
```
public SimpleSheet<T> firstRowAsHeader()
```
    将第一行数据作为表头
    
    返回:
    
    SimpleSheet对象，包含了表头信息
  - getHeaderColumns
```
public Column[] getHeaderColumns()
```
    获取表头信息，未实例化表头时会执行初始化方法实例化表头
    对于简单类型来说表头信息并无任何有效信息，
    
    覆盖:
    
    getHeaderColumns 在类中 ListSheet<T>
    
    返回:
    
    表头信息
  - resetBlockData
```
protected void resetBlockData()
```
    重置RowBlock行块数据
    
    覆盖:
    
    resetBlockData 在类中 ListSheet<T>
  - datetimeCell
```
protected static void datetimeCell(Styles styles,
                                   Cell cell)
```
    日期类型添加默认format
    
    参数:
    
    styles - Styles
    
    cell - 单元格
  - nextBlock
```
public RowBlock nextBlock()
```
    获取下一段RowBlock行块数据，工作表输出协议通过此方法循环获取行数据并落盘，行块被设计为一个滑行窗口，下游输出协议只能获取一个窗口的数据默认包含32行。
    
    覆盖:
    
    nextBlock 在类中 Sheet
    
    返回:
    
    行块
  - getDefaultWidth
```
public double getDefaultWidth()
```
    获取默认列宽，如果未在Column上特殊指定宽度时该宽度将应用于每一列
    
    覆盖:
    
    getDefaultWidth 在类中 Sheet
    
    返回:
    
    默认列宽10
  - defaultDatetimeCell
```
public static void defaultDatetimeCell(Styles styles,
                                       Cell cell)
```
    日期类型添加默认format
    
    参数:
    
    styles - Styles
    
    cell - 单元格

类 SimpleSheet<T>

嵌套类概要

从类继承的嵌套类/接口 org.ttzero.excel.entity.ListSheet

字段概要

从类继承的字段 org.ttzero.excel.entity.ListSheet

从类继承的字段 org.ttzero.excel.entity.Sheet

构造器概要

方法概要

从类继承的方法 org.ttzero.excel.entity.ListSheet

从类继承的方法 org.ttzero.excel.entity.Sheet

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

字段详细资料

type

firstRowAsHeader

UNALLOCATED_COLUMN

构造器详细资料

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

SimpleSheet

方法详细资料

setHeader

setHeader

firstRowAsHeader

getHeaderColumns

resetBlockData

datetimeCell

nextBlock

getDefaultWidth

defaultDatetimeCell