Package io.keikai.api.model.impl

Class SheetImpl

java.lang.Object

io.keikai.api.model.impl.SheetImpl

All Implemented Interfaces:

Sheet, Serializable

public class SheetImpl
extends Object
implements Sheet, Serializable

Since:

3.0.0

Author:

dennis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SheetImpl(ModelRef<SBook> book, ModelRef<SSheet> sheet)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
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
SSheet	getNative()
List<Picture>	getPictures()
ModelRef<SSheet>	getRef()
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()
int	hashCode()
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	isSummaryBelow()	Returns whether to display summary below or above for rows.
boolean	isSummaryRight()	Returns whether to display summary right or left for columns.
boolean	isVeryHidden()	Returns whether this sheet is very hidden.
static SheetAnchor	toSheetAnchor(SSheet sheet, ViewAnchor anchor)	Utility method, internal use only
static ViewAnchor	toViewAnchor(SSheet sheet, SheetAnchor anchor)	Utility method, internal use only

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SheetImpl

public SheetImpl(ModelRef<SBook> book,
                 ModelRef<SSheet> sheet)

Method Detail

getNative

public SSheet getNative()

getInternalSheet

public SSheet getInternalSheet()

Description copied from interface: Sheet

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

Specified by:

getInternalSheet in interface Sheet

Returns:

getRef

public ModelRef<SSheet> getRef()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getBook

public Book getBook()

Specified by:

getBook in interface Sheet

isProtected

public boolean isProtected()

Specified by:

isProtected in interface Sheet

isAutoFilterEnabled

public boolean isAutoFilterEnabled()

Specified by:

isAutoFilterEnabled in interface Sheet

isDisplayGridlines

public boolean isDisplayGridlines()

Specified by:

isDisplayGridlines in interface Sheet

getSheetName

public String getSheetName()

Specified by:

getSheetName in interface Sheet

isRowHidden

public boolean isRowHidden(int row)

Specified by:

isRowHidden in interface Sheet

isColumnHidden

public boolean isColumnHidden(int column)

Specified by:

isColumnHidden in interface Sheet

getCharts

public List<Chart> getCharts()

Specified by:

getCharts in interface Sheet

getPictures

public List<Picture> getPictures()

Specified by:

getPictures in interface Sheet

getRowFreeze

public int getRowFreeze()

Description copied from interface: Sheet

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

Specified by:

getRowFreeze in interface Sheet

Returns:

getColumnFreeze

public int getColumnFreeze()

Description copied from interface: Sheet

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

Specified by:

getColumnFreeze in interface Sheet

Returns:

isPrintGridlines

public boolean isPrintGridlines()

Specified by:

isPrintGridlines in interface Sheet

getRowHeight

public int getRowHeight(int row)

Description copied from interface: Sheet

get row height in pixel

Specified by:

getRowHeight in interface Sheet

Returns:

row height in pixel

getColumnWidth

public int getColumnWidth(int column)

Description copied from interface: Sheet

get column width in pixel

Specified by:

getColumnWidth in interface Sheet

Returns:

column width in pixel

toViewAnchor

public static ViewAnchor toViewAnchor(SSheet sheet,
                                      SheetAnchor anchor)

Utility method, internal use only

toSheetAnchor

public static SheetAnchor toSheetAnchor(SSheet sheet,
                                        ViewAnchor anchor)

Utility method, internal use only

getFirstRow

public int getFirstRow()

Description copied from interface: Sheet

get the first row which contains data of this sheet

Specified by:

getFirstRow in interface Sheet

Returns:

getLastRow

public int getLastRow()

Description copied from interface: Sheet

get the last row which contains data of this sheet

Specified by:

getLastRow in interface Sheet

Returns:

getFirstColumn

public int getFirstColumn(int row)

Description copied from interface: Sheet

Get the first column of row which contains data

Specified by:

getFirstColumn in interface Sheet

Returns:

-1 if not such column or no no such row

getLastColumn

public int getLastColumn(int row)

Description copied from interface: Sheet

Get the last column of row which contains data

Specified by:

getLastColumn in interface Sheet

Returns:

-1 if not such column or no no such row

isHidden

public boolean isHidden()

Description copied from interface: Sheet

Returns whether this sheet is hidden.

Specified by:

isHidden in interface Sheet

isVeryHidden

public boolean isVeryHidden()

Description copied from interface: Sheet

Returns whether this sheet is very hidden.

Specified by:

isVeryHidden in interface Sheet

isSummaryBelow

public boolean isSummaryBelow()

Description copied from interface: Sheet

Returns whether to display summary below or above for rows.

Specified by:

isSummaryBelow in interface Sheet

Returns:

true to display summary below, unless display summary above.

isSummaryRight

public boolean isSummaryRight()

Description copied from interface: Sheet

Returns whether to display summary right or left for columns.

Specified by:

isSummaryRight in interface Sheet

Returns:

true to display summary right, unless display summary left.