org.zkoss.pivot
Interface PivotHeaderNode

All Known Implementing Classes:

SimplePivotHeaderNode

public interface PivotHeaderNode

The representation of a node in row/column header tree.

Author:

simonpai

Method Summary

PivotHeaderNode	getChild(java.lang.Object key) Find child by node key.
java.util.List<? extends PivotHeaderNode>	getChildren() Returns the children of the node.
int	getDepth() Returns the depth of the node, 0 if root.
PivotField	getField() Return the corresponding field of the node
java.lang.Object	getKey() Return the key of node.
PivotHeaderNode	getParent() Returns the parent of the node.
int	getSize(boolean asIfOpen) TODO
int	getSubtotalCount(boolean asIfOpen) TODO
PivotHeaderTree	getTree() Returns the tree of the node.
boolean	isLeaf() Returns true if the node has no child.
boolean	isOpen() Returns true is the node is open.
void	setOpen(boolean open) Set the open state of the node.

Method Detail

getTree

PivotHeaderTree getTree()

Returns the tree of the node.

See Also:

PivotHeaderTree

getParent

PivotHeaderNode getParent()

Returns the parent of the node.

getChildren

java.util.List<? extends PivotHeaderNode> getChildren()

Returns the children of the node.

getDepth

int getDepth()

Returns the depth of the node, 0 if root.

isLeaf

boolean isLeaf()

Returns true if the node has no child.

getChild

PivotHeaderNode getChild(java.lang.Object key)

Find child by node key.

Returns:

null if not found.

getSize

int getSize(boolean asIfOpen)

TODO

getSubtotalCount

int getSubtotalCount(boolean asIfOpen)

TODO

getKey

java.lang.Object getKey()

Return the key of node.

getField

PivotField getField()

Return the corresponding field of the node

isOpen

boolean isOpen()

Returns true is the node is open.

setOpen

void setOpen(boolean open)

Set the open state of the node.