org.zkoss.pivot
Interface PivotRenderer

All Known Subinterfaces:
PivotRendererExt
All Known Implementing Classes:
SimplePivotRenderer

public interface PivotRenderer

PivotRenderer defines some methods for Pivottable to render the content to the browser.

Note: The content can support HTML formatting.

Author:
jumperchen

Method Summary
 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.
 java.lang.String renderCell(java.lang.Number data, Pivottable table, PivotHeaderContext rowContext, PivotHeaderContext columnContext, PivotField dataField)
          Renders the content of each cell.
 java.lang.String renderDataField(PivotField field)
          Renders the label of a data field, shown when there are multiple data fields.
 java.lang.String renderField(java.lang.Object data, Pivottable table, PivotField field)
          Renders the label of a header field in columns and rows.
 java.lang.String renderGrandTotalField(Pivottable table, PivotField field)
          Renders the title of a grand total field.
 java.lang.String renderSubtotalField(java.lang.Object data, Pivottable table, PivotField field, Calculator calculator)
          Renders the label of a subtotal field.
 

Method Detail

renderCell

java.lang.String renderCell(java.lang.Number data,
                            Pivottable table,
                            PivotHeaderContext rowContext,
                            PivotHeaderContext columnContext,
                            PivotField dataField)
Renders the content of each cell. (excluding row fields, column fields)

Parameters:
data - data object
rowContext - row header context object
columnContext - column header context object
See Also:
PivotHeaderContext

renderField

java.lang.String renderField(java.lang.Object data,
                             Pivottable table,
                             PivotField field)
Renders the label of a header field in columns and rows.

Parameters:
data - data object
field - PivotField
See Also:
PivotField

renderDataField

java.lang.String renderDataField(PivotField field)
Renders the label of a data field, shown when there are multiple data fields.


renderSubtotalField

java.lang.String renderSubtotalField(java.lang.Object data,
                                     Pivottable table,
                                     PivotField field,
                                     Calculator calculator)
Renders the label of a subtotal field.

Parameters:
data - data object
field - PivotField
calculator - the subtotal calculator
See Also:
PivotField, Calculator

renderGrandTotalField

java.lang.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 Pivottable
columnContext - information of the corresponding column
field - 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 Pivottable
rowContext - information of the corresponding row
field - the field corresponds to the leaf row cell. Can be row, column, data field, or null (only in the case of grand total)


Copyright © 2013. All Rights Reserved.