Package io.keikai.model

Interface STable

All Superinterfaces:

Table

All Known Implementing Classes:

AbstractTableAdv, TableImpl, TableImpl.DummyTable

public interface STable
extends Table

Table

Since:

3.8.0

Author:

henri

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.Table

isStructuredReference

Method Summary

Modifier and Type	Method	Description
void	addColumn(STableColumn column)
SAutoFilter	createAutoFilter()	Creates a new auto filter for this table the old one will be drop directly.
void	deleteAutoFilter()	Delete current autofilter if it has
void	enableAutoFilter(boolean enable)
SheetRegion	getAllRegion()
SAutoFilter	getAutoFilter()	Gets the auto filter information if there is.
SBook	getBook()
STableColumn	getColumnAt(int colIdx)
List<STableColumn>	getColumns()
SheetRegion	getColumnsRegion(String columnName1, String columnName2)
SheetRegion	getDataRegion()
String	getDisplayName()
int	getHeaderRowCount()
SheetRegion	getHeadersRegion()
SheetRegion	getItemRegion(TablePtg.Item item, int rowIdx)
String	getName()	Get the name of the table.
STableStyleInfo	getTableStyleInfo()
SheetRegion	getThisRowRegion(int rowIdx)
SheetRegion	getTotalsRegion()
int	getTotalsRowCount()
void	setDisplayName(String name)
void	setHeaderRowCount(int count)
void	setName(String name)
void	setTotalsRowCount(int count)

Methods inherited from interface org.apache.poi.ss.usermodel.Table

contains, contains, findColumnIndex, getEndColIndex, getEndRowIndex, getSheetName, getStartColIndex, getStartRowIndex, getStyle, getStyleName, isHasTotalsRow

Method Detail

getBook

SBook getBook()

getAutoFilter

SAutoFilter getAutoFilter()

Gets the auto filter information if there is.

Returns:

the auto filter, or null if not found

enableAutoFilter

void enableAutoFilter(boolean enable)

createAutoFilter

SAutoFilter createAutoFilter()

Creates a new auto filter for this table the old one will be drop directly.

Returns:

the new auto filter.

deleteAutoFilter

void deleteAutoFilter()

Delete current autofilter if it has

addColumn

void addColumn(STableColumn column)

getColumns

List<STableColumn> getColumns()

getColumnAt

STableColumn getColumnAt(int colIdx)

getTableStyleInfo

STableStyleInfo getTableStyleInfo()

getTotalsRowCount

int getTotalsRowCount()

Specified by:

getTotalsRowCount in interface Table

Returns:

0 for no totals rows, 1 for totals row shown. Values > 1 are not currently used by Excel up through 2016, and the OOXML spec doesn't define how they would be implemented.

setTotalsRowCount

void setTotalsRowCount(int count)

getHeaderRowCount

int getHeaderRowCount()

Specified by:

getHeaderRowCount in interface Table

Returns:

0 for no header rows, 1 for table headers shown. Values > 1 might be used by Excel for pivot tables?

setHeaderRowCount

void setHeaderRowCount(int count)

getName

String getName()

Description copied from interface: Table

Get the name of the table.

Specified by:

getName in interface Table

Returns:

table name

setName

void setName(String name)

getDisplayName

String getDisplayName()

setDisplayName

void setDisplayName(String name)

getAllRegion

SheetRegion getAllRegion()

getDataRegion

SheetRegion getDataRegion()

getColumnsRegion

SheetRegion getColumnsRegion(String columnName1,
                             String columnName2)

getHeadersRegion

SheetRegion getHeadersRegion()

getTotalsRegion

SheetRegion getTotalsRegion()

getThisRowRegion

SheetRegion getThisRowRegion(int rowIdx)

getItemRegion

SheetRegion getItemRegion(TablePtg.Item item,
                          int rowIdx)