Package org.zkoss.pivot

Class PivotHeaderContext

java.lang.Object

org.zkoss.pivot.PivotHeaderContext

public class PivotHeaderContext
extends Object

The information context for assisting rendering, representing a PivotHeaderNode or a subtotal Calculator slot in columns or rows.

Author:

simonpai

Constructor Summary

Constructors

Constructor	Description
PivotHeaderContext(int displayIndex)
PivotHeaderContext(PivotHeaderNode node, Calculator calculator, int displayIndex)

Method Summary

Modifier and Type	Method	Description
Calculator	getCalculator()	Returns the subtotal Calculator if the context represents a subtotal slot, null otherwise.
int	getDisplayIndex()	Returns the displayed index of the slot in columns or rows.
PivotHeaderNode	getNode()	Returns the PivotHeaderNode corresponding to the slot.
boolean	isGrandTotal()	Return true is the context represents a grand total rank.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PivotHeaderContext

public PivotHeaderContext(int displayIndex)

PivotHeaderContext

public PivotHeaderContext(PivotHeaderNode node,
 Calculator calculator,
 int displayIndex)

Method Details

getNode

public PivotHeaderNode getNode()

Returns the PivotHeaderNode corresponding to the slot.

getCalculator

public Calculator getCalculator()

Returns the subtotal Calculator if the context represents a subtotal slot, null otherwise.

getDisplayIndex

public int getDisplayIndex()

Returns the displayed index of the slot in columns or rows. Data fields are not taken into account. The first data cell has display indices (0,0).

isGrandTotal

public boolean isGrandTotal()

Return true is the context represents a grand total rank.