com.klg.jclass.higrid
Class RowNode

java.lang.Object
  |
  +--javax.swing.tree.DefaultMutableTreeNode
        |
        +--com.klg.jclass.datasource.DataSourceTreeNode
              |
              +--com.klg.jclass.higrid.RowNode

All Implemented Interfaces:

Cloneable, MutableTreeNode, Serializable, TreeNode

public class RowNode

extends DataSourceTreeNode

The RowNode class aggregates all of the information necessary to render a specific row within a given table. A RowNode is constructed from one of the five basic RowFormat subclasses: Record, Header, Footer, BeforeDetails, AfterDetails. Thus, a RowNode can either be based entirely on information from a FormatNode (e.g. Header), or from information from the datasource (e.g. Record), or from some computed information (Footer, BeforeDetails, AfterDetails). An individual instance of the RowNode class can usually be found as an element in the (@ link RowTree}.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

RowNode()
Default constructor.

RowNode(com.klg.jclass.higrid.FormatNode node, com.klg.jclass.higrid.RowFormat format, com.klg.jclass.datasource.DataTableModel dataTableModel, long bookmark)
Constructor for RowNode.

Method Summary

protected boolean	draw(Graphics gc, com.klg.jclass.higrid.HiGrid grid) Delegates to the rowFormat object to draw itself.
long	getBookmark() Retrieves the bookmark for this object.
com.klg.jclass.datasource.DataTableModel	getDataTableModel() Retrieves the DataTableModel for this object.
com.klg.jclass.higrid.FormatNode	getFormatNode() Retrieves the format node for this object.
int	getHeight() Retrieves the height of this object.
com.klg.jclass.higrid.RowFormat	getRowFormat() Retrieves the row format for this object.
byte	getState() Retrieves the state of the row.
int	getWidth() Retrieves the width of this object.
boolean	isSelected() Retrieves the selected state of the row.
protected void	setDataTableModel(com.klg.jclass.datasource.DataTableModel dataTableModel) Sets the DataTableModel for this object.
protected void	setFormatNode(com.klg.jclass.higrid.FormatNode node) Sets the format node for this object.
protected void	setHeight(int height) Sets the height of this object.
protected void	setRowFormat(com.klg.jclass.higrid.RowFormat format) Sets the row format for this object.
protected void	setSelected(boolean selected) Sets the selected state of the row
protected void	setState(byte state) Sets the state of the row
protected void	setWidth(int width) Sets the width of this object.
String	toString() Returns a string representation of the object.

Methods inherited from class com.klg.jclass.datasource.DataSourceTreeNode

getChildren, getFirstChild, getIterator, getIterator, getIterator, getIterator, getLastChild, getNextChild, getPreviousChild, hasChildren, insert, isChildOf

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstLeaf, getIndex, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

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

Constructor Detail

RowNode

public RowNode()

Default constructor.

RowNode

public RowNode(com.klg.jclass.higrid.FormatNode node,
               com.klg.jclass.higrid.RowFormat format,
               com.klg.jclass.datasource.DataTableModel dataTableModel,
               long bookmark)

Constructor for RowNode.

Parameters:

node - The FormatNode to associate with this object.

format - The RowFormat to associate with this object.

dataTableModel - The DataTableModel to associate with this object.

Method Detail

getBookmark

public long getBookmark()

Retrieves the bookmark for this object.

Returns:

The object's bookmark.

getDataTableModel

public com.klg.jclass.datasource.DataTableModel getDataTableModel()

Retrieves the DataTableModel for this object.

Returns:

The current DataTableModel.

setDataTableModel

protected void setDataTableModel(com.klg.jclass.datasource.DataTableModel dataTableModel)

Sets the DataTableModel for this object.

Parameters:

dataTableModel - The new DataTableModel for this object.

getFormatNode

public com.klg.jclass.higrid.FormatNode getFormatNode()

Retrieves the format node for this object.

Returns:

The current format node.

setFormatNode

protected void setFormatNode(com.klg.jclass.higrid.FormatNode node)

Sets the format node for this object.

Parameters:

node - The new format node.

getRowFormat

public com.klg.jclass.higrid.RowFormat getRowFormat()

Retrieves the row format for this object.

Returns:

The current row format.

setRowFormat

protected void setRowFormat(com.klg.jclass.higrid.RowFormat format)

Sets the row format for this object.

Parameters:

format - The new row format.

getState

public byte getState()

Retrieves the state of the row.

Returns:

The state of the row.

setState

protected void setState(byte state)

Sets the state of the row

Parameters:

state - The state of the row.

isSelected

public boolean isSelected()

Retrieves the selected state of the row.

Returns:

The selected state of the row.

setSelected

protected void setSelected(boolean selected)

Sets the selected state of the row

Parameters:

selected - The selected state of the row.

draw

protected boolean draw(Graphics gc,
                       com.klg.jclass.higrid.HiGrid grid)

Delegates to the rowFormat object to draw itself.

Parameters:

gc - The graphics context to draw into.

grid - The instance of HiGrid this row belongs to.

getHeight

public int getHeight()

Retrieves the height of this object.

Returns:

The current height.

setHeight

protected void setHeight(int height)

Sets the height of this object.

Parameters:

height - The new height.

getWidth

public int getWidth()

Retrieves the width of this object.

Returns:

The current width.

setWidth

protected void setWidth(int width)

Sets the width of this object.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class DataSourceTreeNode

Returns:

a string representation of the object.