org.zkoss.poi.ss.usermodel

Interface PivotTable

All Known Implementing Classes:

XSSFPivotTable

public interface PivotTable

Author:

sam

Method Summary

Modifier and Type	Method and Description
long	getCacheId() Returns the cache id of the PivotTable.
List<PivotField>	getColumnFields() Returns all column fields.
String	getDataCaption() Returns the data caption.
List<DataField>	getDataFields() Returns all data fields.
boolean	getDataOnRows() Returns whether data on rows or not.
CellReference	getFirstDataRef() Returns the first data CellReference
String	getGrandTotalCaption() Returns the grand total caption.
AreaReference	getLocationRef() Returns the location range of the PivotTable.
String	getName() Returns the name of the PivotTable.
boolean	getOutline()
boolean	getOutlineData()
PivotCache	getPivotCache() Returns the PivotCache of the PivotTable.
PivotField	getPivotField(String name) Returns the PivotField.
List<PivotField>	getPivotFields() Returns all fields of the PivotTable.
List<PivotField>	getRowFields() Returns all row fields.
String	getRowHeaderCaption() Returns the row header caption.
void	setColumnField(PivotField field) Sets column type of a pivot field.
void	setColumnItems(List<List<ItemInfo>> items) Serts column items
void	setDataCaption(String caption) Sets the data caption.
void	setDataField(PivotField field, String name, Calculation subtotal) Sets data field
void	setDataOnRows(boolean dataOnRows) Sets data on rows
void	setFirstData(int row, int col) Sets the first data row/column index.
void	setFirstHeaderRow(int row) Sets the first header row.
void	setGrandTotalCaption(String caption) Sets the grand total caption.
void	setLocationRef(AreaReference ref) Sets the location range of the PivotTable.
void	setName(String name) Sets the name of PivotTable.
void	setOutline(boolean outline)
void	setOutlineData(boolean outlineData)
void	setRowField(PivotField field) Sets row type of a pivot field.
void	setRowHeaderCaption(String caption) Sets the row header caption.
void	setRowItems(List<List<ItemInfo>> items) Sets row items.

Method Detail

setName

void setName(String name)

Sets the name of PivotTable.

Parameters:

name -

getName

String getName()

Returns the name of the PivotTable.

Returns:

name

getCacheId

long getCacheId()

Returns the cache id of the PivotTable.

Returns:

cache id

setGrandTotalCaption

void setGrandTotalCaption(String caption)

Sets the grand total caption.

Parameters:

caption -

getGrandTotalCaption

String getGrandTotalCaption()

Returns the grand total caption.

Returns:

caption

setDataCaption

void setDataCaption(String caption)

Sets the data caption.

Parameters:

caption -

getDataCaption

String getDataCaption()

Returns the data caption.

Returns:

setRowHeaderCaption

void setRowHeaderCaption(String caption)

Sets the row header caption.

Parameters:

caption -

getRowHeaderCaption

String getRowHeaderCaption()

Returns the row header caption.

Returns:

setFirstHeaderRow

void setFirstHeaderRow(int row)

Sets the first header row.

Parameters:

row -

setFirstData

void setFirstData(int row,
                  int col)

Sets the first data row/column index.

Parameters:

row -

col -

getFirstDataRef

CellReference getFirstDataRef()

Returns the first data CellReference

Returns:

setLocationRef

void setLocationRef(AreaReference ref)

Sets the location range of the PivotTable.

Parameters:

ref -

getLocationRef

AreaReference getLocationRef()

Returns the location range of the PivotTable.

Returns:

getPivotCache

PivotCache getPivotCache()

Returns the PivotCache of the PivotTable.

Returns:

getPivotField

PivotField getPivotField(String name)

Returns the PivotField.

Parameters:

name -

Returns:

getPivotFields

List<PivotField> getPivotFields()

Returns all fields of the PivotTable.

Returns:

setRowField

void setRowField(PivotField field)

Sets row type of a pivot field.

Parameters:

field -

getRowFields

List<PivotField> getRowFields()

Returns all row fields.

Returns:

setRowItems

void setRowItems(List<List<ItemInfo>> items)

Sets row items.

Parameters:

items -

setColumnField

void setColumnField(PivotField field)

Sets column type of a pivot field.

Parameters:

field -

getColumnFields

List<PivotField> getColumnFields()

Returns all column fields.

Returns:

setColumnItems

void setColumnItems(List<List<ItemInfo>> items)

Serts column items

Parameters:

items -

setDataField

void setDataField(PivotField field,
                  String name,
                  Calculation subtotal)

Sets data field

Parameters:

field -

name -

subtotal -

getDataFields

List<DataField> getDataFields()

Returns all data fields.

Returns:

setDataOnRows

void setDataOnRows(boolean dataOnRows)

Sets data on rows

Parameters:

dataOnRows -

getDataOnRows

boolean getDataOnRows()

Returns whether data on rows or not.

Returns:

setOutline

void setOutline(boolean outline)

getOutline

boolean getOutline()

setOutlineData

void setOutlineData(boolean outlineData)

getOutlineData

boolean getOutlineData()