Package org.zkoss.pivot.util
Interface PivotExportContext
-
public interface PivotExportContext
A context object containing information required for exporting to other files
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PivotField[]
getAllFields()
Returns all fields.PivotExportCell
getCell(int rowIndex, int columnIndex)
Retrieve the cell information at given position.int
getColumnCount(boolean withDataField, boolean withGrandTotal)
Retrieve the column count of the column field area.PivotField[]
getColumnFields()
Returns column fields.int
getColumnOffset()
Retrieve the column count of the row field area, which is also the column span of the row title cell.PivotField[]
getDataFields()
Returns data fields.Iterable<String>
getRawColumns()
Returns raw fields.Iterable<? extends List<?>>
getRawData()
Returns raw data.int
getRowCount(boolean withDataField, boolean withGrandTotal)
Retrieve the row count of the row field area.PivotField[]
getRowFields()
Returns row fields.int
getRowOffset()
Retrieve the row count of the column field area, which is also the row span of the row title cell.PivotExportSheetConfig
getSheetConfig()
int
getSheetHeight()
Return sheet height, the total row count.int
getSheetWidth()
Return sheet width, the total column count.PivotExportCell
getTitleCell(PivotExportCell.Type type)
Retrieves one of the title cells.boolean
isDataFieldColumnOrient()
Returns data fields.boolean
isOpen()
open all row/column headers when exporting
-
-
-
Method Detail
-
getColumnOffset
int getColumnOffset()
Retrieve the column count of the row field area, which is also the column span of the row title cell.
-
getRowOffset
int getRowOffset()
Retrieve the row count of the column field area, which is also the row span of the row title cell.
-
getColumnCount
int getColumnCount(boolean withDataField, boolean withGrandTotal)
Retrieve the column count of the column field area.- Parameters:
withDataField
- whether to concern data field. If true and there are multiple data fields, the count is multiplied by the number of data fields.withGrandTotal
- whether to include grand total fields.
-
getRowCount
int getRowCount(boolean withDataField, boolean withGrandTotal)
Retrieve the row count of the row field area.- Parameters:
withDataField
- whether to concern data field. If true and there are multiple data fields, the count is multiplied by the number of data fields.withGrandTotal
- whether to include grand total fields.
-
getSheetWidth
int getSheetWidth()
Return sheet width, the total column count.
-
getSheetHeight
int getSheetHeight()
Return sheet height, the total row count.
-
getCell
PivotExportCell getCell(int rowIndex, int columnIndex)
Retrieve the cell information at given position.
-
getTitleCell
PivotExportCell getTitleCell(PivotExportCell.Type type)
Retrieves one of the title cells.- Parameters:
type
- must be TITLE_DATA, TITLE_COLUMN, or TITLE_ROW
-
getRowFields
PivotField[] getRowFields()
Returns row fields.
-
getColumnFields
PivotField[] getColumnFields()
Returns column fields.
-
getDataFields
PivotField[] getDataFields()
Returns data fields.
-
getAllFields
PivotField[] getAllFields()
Returns all fields.
-
isDataFieldColumnOrient
boolean isDataFieldColumnOrient()
Returns data fields.
-
isOpen
boolean isOpen()
open all row/column headers when exporting- Returns:
- flag
-
getSheetConfig
PivotExportSheetConfig getSheetConfig()
- Returns:
- the current Sheet Configuration
-
-