io.keikai.api.model

Interface Sheet

All Known Implementing Classes:

SheetImpl

public interface Sheet

This interface provides the access to a sheet of a Book.

Since:

3.0.0

Author:

dennis

Method Summary

Modifier and Type	Method and Description
Book	getBook()
List<Chart>	getCharts()
int	getColumnFreeze() Get number of column freeze of this sheet, 0 means no column freeze
int	getColumnWidth(int column) get column width in pixel
int	getFirstColumn(int row) Get the first column of row which contains data
int	getFirstRow() get the first row which contains data of this sheet
SSheet	getInternalSheet() get the internal model object to do advanced operation Note : operate on internal object will not automatically update Spreadsheet
int	getLastColumn(int row) Get the last column of row which contains data
int	getLastRow() get the last row which contains data of this sheet
List<Picture>	getPictures()
int	getRowFreeze() Get number of row freeze of this sheet, 0 means no row freeze
int	getRowHeight(int row) get row height in pixel
String	getSheetName()
Object	getSync() Gets the object for synchronized a sheet.
boolean	isAutoFilterEnabled()
boolean	isColumnHidden(int column)
boolean	isDisplayGridlines()
boolean	isHidden() Returns whether this sheet is hidden.
boolean	isPrintGridlines()
boolean	isProtected()
boolean	isRowHidden(int row)
boolean	isVeryHidden() Returns whether this sheet is very hidden.

Method Detail

getInternalSheet

SSheet getInternalSheet()

get the internal model object to do advanced operation
Note : operate on internal object will not automatically update Spreadsheet

Returns:

getBook

Book getBook()

getSync

Object getSync()

Gets the object for synchronized a sheet. Note: you shouldn't synchronize a sheet directly, you have to get the sync object to synchronize it

Returns:

isProtected

boolean isProtected()

isAutoFilterEnabled

boolean isAutoFilterEnabled()

isDisplayGridlines

boolean isDisplayGridlines()

isRowHidden

boolean isRowHidden(int row)

isColumnHidden

boolean isColumnHidden(int column)

getSheetName

String getSheetName()

getCharts

List<Chart> getCharts()

getPictures

List<Picture> getPictures()

getRowFreeze

int getRowFreeze()

Get number of row freeze of this sheet, 0 means no row freeze

Returns:

getColumnFreeze

int getColumnFreeze()

Get number of column freeze of this sheet, 0 means no column freeze

Returns:

isPrintGridlines

boolean isPrintGridlines()

getRowHeight

int getRowHeight(int row)

get row height in pixel

Parameters:

row -

Returns:

row height in pixel

getColumnWidth

int getColumnWidth(int column)

get column width in pixel

Parameters:

column -

Returns:

column width in pixel

getFirstRow

int getFirstRow()

get the first row which contains data of this sheet

Returns:

getLastRow

int getLastRow()

get the last row which contains data of this sheet

Returns:

getFirstColumn

int getFirstColumn(int row)

Get the first column of row which contains data

Parameters:

row -

Returns:

-1 if not such column or no no such row

getLastColumn

int getLastColumn(int row)

Get the last column of row which contains data

Parameters:

row -

Returns:

-1 if not such column or no no such row

isHidden

boolean isHidden()

Returns whether this sheet is hidden.

Since:

3.7.0

isVeryHidden

boolean isVeryHidden()

Returns whether this sheet is very hidden.

Since:

3.7.0