Package org.zkoss.pivot
Interface PivotRenderer
-
- All Known Subinterfaces:
PivotRendererExt
- All Known Implementing Classes:
SimplePivotRenderer
public interface PivotRenderer
PivotRenderer defines some methods forPivottable
to render the content to the browser.Note: The content can support HTML formatting.
- Author:
- jumperchen
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getColumnSize(Pivottable table, PivotHeaderContext columnContext, PivotField field)
Returns the column size in pixel.int
getRowSize(Pivottable table, PivotHeaderContext rowContext, PivotField field)
Returns the row size in pixel.String
renderCell(Number data, Pivottable table, PivotHeaderContext rowContext, PivotHeaderContext columnContext, PivotField dataField)
Renders the content of each cell.String
renderDataField(PivotField field)
Renders the label of a data field, shown when there are multiple data fields.String
renderField(Object data, Pivottable table, PivotField field)
Renders the label of a header field in columns and rows.String
renderGrandTotalField(Pivottable table, PivotField field)
Renders the title of a grand total field.String
renderSubtotalField(Object data, Pivottable table, PivotField field, Calculator calculator)
Renders the label of a subtotal field.
-
-
-
Method Detail
-
renderCell
String renderCell(Number data, Pivottable table, PivotHeaderContext rowContext, PivotHeaderContext columnContext, PivotField dataField)
Renders the content of each cell. (excluding row fields, column fields)- Parameters:
data
- data objectrowContext
- row header context objectcolumnContext
- column header context object- See Also:
PivotHeaderContext
-
renderField
String renderField(Object data, Pivottable table, PivotField field)
Renders the label of a header field in columns and rows.- Parameters:
data
- data objectfield
- PivotField- See Also:
PivotField
-
renderDataField
String renderDataField(PivotField field)
Renders the label of a data field, shown when there are multiple data fields.
-
renderSubtotalField
String renderSubtotalField(Object data, Pivottable table, PivotField field, Calculator calculator)
Renders the label of a subtotal field.- Parameters:
data
- data objectfield
- PivotFieldcalculator
- the subtotal calculator- See Also:
PivotField
,Calculator
-
renderGrandTotalField
String renderGrandTotalField(Pivottable table, PivotField field)
Renders the title of a grand total field.- Parameters:
field
- a data PivotField
-
getColumnSize
int getColumnSize(Pivottable table, PivotHeaderContext columnContext, PivotField field)
Returns the column size in pixel.Note that the cell field always from 0 to m, and the returned value is never negative.
- Parameters:
table
- the PivottablecolumnContext
- information of the corresponding columnfield
- the field corresponds to the leaf column cell. Can be row, column, data field, or null (only in the case of grand total)
-
getRowSize
int getRowSize(Pivottable table, PivotHeaderContext rowContext, PivotField field)
Returns the row size in pixel.Note that the cell field always from 0 to m, and the returned value is never negative.
- Parameters:
table
- the PivottablerowContext
- information of the corresponding rowfield
- the field corresponds to the leaf row cell. Can be row, column, data field, or null (only in the case of grand total)
-
-