Package org.zkoss.pivot

Interface PivotField

All Known Implementing Classes:

SimplePivotField, TabularPivotField

public interface PivotField

PivotField defines the methods to represent a field within a pivot table.

Author:

jumperchen, dennis

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PivotField.Type	Type of pivot field, which indicates whether the field is a column field, row field, or data field.

Method Summary

Modifier and Type	Method	Description
void	addFieldDataListener(FieldDataListener f)	Adds a field data listener to the pivot field.
String	getFieldName()	Returns the field name which indicates the name within the data model
GroupHandler	getGroupHandler()	Returns the group handler.
Calculator	getSubtotal(int index)	Returns the ith subtotal calculator on the field.
Calculator[]	getSubtotals()	Returns a set of subtotal calculator in order.
Calculator	getSummary()	Returns the summary calculator
String	getTitle()	Returns the title of the field.
PivotField.Type	getType()	Returns the area type.
void	removeFieldDataListener(FieldDataListener f)	Removes the specified field data listener from the pivot field.

Method Details

getTitle

String getTitle()

Returns the title of the field.

getType

PivotField.Type getType()

Returns the area type.

See Also:

• PivotField.Type

getFieldName

String getFieldName()

Returns the field name which indicates the name within the data model

getGroupHandler

GroupHandler getGroupHandler()

Returns the group handler.

addFieldDataListener

void addFieldDataListener(FieldDataListener f)

Adds a field data listener to the pivot field.

removeFieldDataListener

void removeFieldDataListener(FieldDataListener f)

Removes the specified field data listener from the pivot field.

getSubtotals

Calculator[] getSubtotals()

Returns a set of subtotal calculator in order.

getSubtotal

Calculator getSubtotal(int index)

Returns the ith subtotal calculator on the field.

getSummary

Calculator getSummary()

Returns the summary calculator